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

GetMember

Gets member information for your organization.

Request Syntax


POST /members/get HTTP/1.1
Content-type: application/json

{
   "accountId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountId

The AWS account ID of the member account to retrieve information on.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "member": { 
      "accountId": "string",
      "delegatedAdminAccountId": "string",
      "relationshipStatus": "string",
      "updatedAt": number
   }
}

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.

member

Details of the retrieved member account.

Type: Member object

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal failure of the Amazon Inspector service.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

HTTP Status Code: 400