Menu
Amazon Inspector
API Reference (API Version 2016-02-16)

DescribeCrossAccountAccessRole

Describes the IAM role that enables Amazon Inspector to access your AWS account.

Response Syntax

{
   "registeredAt": number,
   "roleArn": "string",
   "valid": boolean
}

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.

registeredAt

The date when the cross-account access role was registered.

Type: Timestamp

roleArn

The ARN that specifies the IAM role that Amazon Inspector uses to access your AWS account.

Type: String

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

valid

A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Amazon Inspector to access your AWS account.

Type: Boolean

Errors

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

InternalException

Internal server error.

HTTP Status Code: 500

Example

Sample Request


               
               POST / HTTP/1.1
               Host: inspector.us-west-2.amazonaws.com
               Accept-Encoding: identity
               Content-Length: 2
               X-Amz-Target: InspectorService.DescribeCrossAccountAccessRole
               X-Amz-Date: 20160323T215330Z
               User-Agent: aws-cli/1.10.12 Python/2.7.9 Windows/7 botocore/1.4.3
               Content-Type: application/x-amz-json-1.1
               Authorization: AUTHPARAMS
               {}
               
            

Sample Response


               
               HTTP/1.1 200 OK
               x-amzn-RequestId: aef491a7-f141-11e5-bf1e-bbcaffe8bf2e
               Content-Type: application/x-amz-json-1.1
               Content-Length: 99
               Date: Wed, 23 Mar 2016 21:53:32 GMT
               {
                 "registeredAt": 1458069182.826,
                 "roleArn": "arn:aws:iam::123456789012:role/inspector",
                 "valid": true
               }               
               
            

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: