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

describe-organization-configuration

Description

Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-organization-configuration
[--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 view information about an integration with AWS Organizations

The following describe-organization-configuration example returns information about the integration with Organizations.

aws securityhub describe-organization-configuration

Output:

{
    "autoEnable": true,
    "memberAccountLimitReached": false
}

For more information, see Managing accounts in the AWS Security Hub User Guide.

Output

AutoEnable -> (boolean)

Whether to automatically enable Security Hub for new accounts in the organization.

If set to true , then Security Hub is enabled for new accounts. If set to false, then new accounts are not added automatically.

MemberAccountLimitReached -> (boolean)

Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.