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

BatchGetMemberAccountDetails

Provides information on whether the supplied account IDs are associated with a membership.

Note

AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

Request Syntax


POST /v1/membership/membershipId/batch-member-details HTTP/1.1
Content-type: application/json

{
   "accountIds": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

membershipId

Required element used in combination with BatchGetMemberAccountDetails to identify the membership ID to query.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

accountIds

Optional element to query the membership relationship status to a provided list of account IDs.

Note

Type: Array of strings

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

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "accountId": "string",
         "error": "string",
         "message": "string"
      }
   ],
   "items": [ 
      { 
         "accountId": "string",
         "relationshipStatus": "string",
         "relationshipType": "string"
      }
   ]
}

Response Elements

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

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

errors

The response element providing error messages for requests to GetMembershipAccountDetails.

Type: Array of GetMembershipAccountDetailError objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

items

The response element providing responses for requests to GetMembershipAccountDetails.

Type: Array of GetMembershipAccountDetailItem objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Errors

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

AccessDeniedException

message: The ID of the resource which lead to the access denial.

HTTP Status Code: 403

ConflictException

message: The exception message.
resourceId: The ID of the conflicting resource.
resourceType: The type of the conflicting resource.

HTTP Status Code: 409

InternalServerException

message: The exception message.
retryAfterSeconds: The number of seconds after which to retry the request.

HTTP Status Code: 500

InvalidTokenException

message: The exception message.

HTTP Status Code: 423

ResourceNotFoundException

message: The exception message.

HTTP Status Code: 404

SecurityIncidentResponseNotActiveException

message: The exception message.

HTTP Status Code: 400

ServiceQuotaExceededException

message: The exception message.
quotaCode: The code of the quota.
resourceId: The ID of the requested resource which lead to the service quota exception.
resourceType: The type of the requested resource which lead to the service quota exception.
serviceCode: The service code of the quota.

HTTP Status Code: 402

ThrottlingException

message: The exception message.
quotaCode: The quota code of the exception.
retryAfterSeconds: The number of seconds after which to retry the request.
serviceCode: The service code of the exception.

HTTP Status Code: 429

ValidationException

fieldList: The fields which lead to the exception.
message: The exception message.
reason: The reason for the exception.

HTTP Status Code: 400