Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . inspector ]

describe-cross-account-access-role

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-cross-account-access-role
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To describe the cross account access role

The following describe-cross-account-access-role command describes the IAM role that enables Amazon Inspector to access your AWS account:

aws inspector describe-cross-account-access-role

Output:

{
        "registeredAt": 1458069182.826,
        "roleArn": "arn:aws:iam::123456789012:role/inspector",
        "valid": true
}

For more information, see Setting up Amazon Inspector in the Amazon Inspector guide.

Output

roleArn -> (string)

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

valid -> (boolean)

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

registeredAt -> (timestamp)

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