Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateMembership

Creates a new membership.

Request Syntax


POST /v1/membership HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "incidentResponseTeam": [ 
      { 
         "email": "string",
         "jobTitle": "string",
         "name": "string"
      }
   ],
   "membershipName": "string",
   "optInFeatures": [ 
      { 
         "featureName": "string",
         "isEnabled": boolean
      }
   ],
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

Note

The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

incidentResponseTeam

Required element used in combination with CreateMembership to add customer incident response team members and trusted partners to the membership.

Type: Array of IncidentResponder objects

Array Members: Minimum number of 2 items. Maximum number of 10 items.

Required: Yes

membershipName

Required element used in combination with CreateMembership to create a name for the membership.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 50.

Required: Yes

optInFeatures

Optional element to enable the monitoring and investigation opt-in features for the service.

Type: Array of OptInFeature objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: No

tags

Optional element for customer configured tags.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "membershipId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

membershipId

Response element for CreateMembership providing the newly created membership ID.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 34.

Pattern: m-[a-z0-9]{10,32}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 403

ConflictException

HTTP Status Code: 409

InternalServerException

HTTP Status Code: 500

InvalidTokenException

HTTP Status Code: 423

ResourceNotFoundException

HTTP Status Code: 404

SecurityIncidentResponseNotActiveException

HTTP Status Code: 400

ServiceQuotaExceededException

HTTP Status Code: 402

ThrottlingException

HTTP Status Code: 429

ValidationException

HTTP Status Code: 400