[ aws . securityhub ]

get-master-account

Description

Provides the details for the Security Hub master account for the current member account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-master-account
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve information about a master account

The following get-master-account example retrieves information about the master account for the requesting account.

aws securityhub get-master-account

Output:

{
    "Master": {
        "AccountId": "123456789012",
        "InvitationId": "7ab938c5d52d7904ad09f9e7c20cc4eb",
        "InvitedAt": 2020-06-01T20:21:18.042000+00:00,
        "MemberStatus": "ASSOCIATED"
    }
}

For more information, see Master and member accounts in the AWS Security Hub User Guide.

Output

Master -> (structure)

A list of details about the Security Hub master account for the current member account.

AccountId -> (string)

The account ID of the Security Hub master account that the invitation was sent from.

InvitationId -> (string)

The ID of the invitation sent to the member account.

InvitedAt -> (timestamp)

The timestamp of when the invitation was sent.

MemberStatus -> (string)

The current status of the association between the member and master accounts.