[ aws . securityhub ]

list-organization-admin-accounts

Description

Lists the Security Hub administrator accounts. Can only be called by the organization management account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-organization-admin-accounts
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--max-results (integer)

The maximum number of items to return in the response.

--next-token (string)

The token that is required for pagination. On your first call to the ListOrganizationAdminAccounts operation, set the value of this parameter to NULL . For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

--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.

See ‘aws help’ for descriptions of global parameters.

Examples

To list the designated Security Hub administrator accounts

The following list-organization-admin-accounts example lists the Security Hub administrator accounts for an organization.

aws securityhub list-organization-admin-accounts

Output:

{
    AdminAccounts": [
        { "AccountId": "777788889999" },
        { "Status": "ENABLED" }
    ]
}

For more information, see Designating a Security Hub administrator account in the AWS Security Hub User Guide.

Output

AdminAccounts -> (list)

The list of Security Hub administrator accounts.

(structure)

Represents a Security Hub administrator account designated by an organization management account.

AccountId -> (string)

The AWS account identifier of the Security Hub administrator account.

Status -> (string)

The current status of the Security Hub administrator account. Indicates whether the account is currently enabled as a Security Hub administrator.

NextToken -> (string)

The pagination token to use to request the next page of results.