[ aws . guardduty ]

describe-organization-configuration

Description

Returns information about the account selected as the delegated administrator for GuardDuty.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints .

See also: AWS API Documentation

Synopsis

  describe-organization-configuration
--detector-id <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--detector-id (string)

The detector ID of the delegated administrator for which you need to retrieve the information.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

--max-results (integer)

You can use this parameter to indicate the maximum number of items that you want in the response.

--next-token (string)

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

AutoEnable -> (boolean)

Indicates whether GuardDuty is automatically enabled for accounts added to the organization.

Even though this is still supported, we recommend using AutoEnableOrganizationMembers to achieve the similar results.

MemberAccountLimitReached -> (boolean)

Indicates whether the maximum number of allowed member accounts are already associated with the delegated administrator account for your organization.

DataSources -> (structure)

Describes which data sources are enabled automatically for member accounts.

S3Logs -> (structure)

Describes whether S3 data event logs are enabled as a data source.

AutoEnable -> (boolean)

A value that describes whether S3 data event logs are automatically enabled for new members of the organization.

Kubernetes -> (structure)

Describes the configuration of Kubernetes data sources.

AuditLogs -> (structure)

The current configuration of Kubernetes audit logs as a data source for the organization.

AutoEnable -> (boolean)

Whether Kubernetes audit logs data source should be auto-enabled for new members joining the organization.

MalwareProtection -> (structure)

Describes the configuration of Malware Protection data source for an organization.

ScanEc2InstanceWithFindings -> (structure)

Describes the configuration for scanning EC2 instances with findings for an organization.

EbsVolumes -> (structure)

Describes the configuration for scanning EBS volumes for an organization.

AutoEnable -> (boolean)

An object that contains the status of whether scanning EBS volumes should be auto-enabled for new members joining the organization.

Features -> (list)

A list of features that are configured for this organization.

(structure)

A list of features which will be configured for the organization.

Name -> (string)

The name of the feature that is configured for the member accounts within the organization.

AutoEnable -> (string)

Describes the status of the feature that is configured for the member accounts within the organization.

• NEW : Indicates that when a new account joins the organization, they will have the feature enabled automatically.
• ALL : Indicates that all accounts in the organization have the feature enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.
• NONE : Indicates that the feature will not be automatically enabled for any account in the organization. In this case, each account will be managed individually by the administrator.

AdditionalConfiguration -> (list)

The additional configuration that is configured for the member accounts within the organization.

(structure)

A list of additional configuration which will be configured for the organization.

Name -> (string)

The name of the additional configuration that is configured for the member accounts within the organization.

AutoEnable -> (string)

Describes the status of the additional configuration that is configured for the member accounts within the organization. One of the following values is the status for the entire organization:

• NEW : Indicates that when a new account joins the organization, they will have the additional configuration enabled automatically.
• ALL : Indicates that all accounts in the organization have the additional configuration enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty. It may take up to 24 hours to update the configuration for all the member accounts.
• NONE : Indicates that the additional configuration will not be automatically enabled for any account in the organization. The administrator must manage the additional configuration for each account individually.

NextToken -> (string)

The pagination parameter to be used on the next list operation to retrieve more items.

AutoEnableOrganizationMembers -> (string)

Indicates the auto-enablement configuration of GuardDuty or any of the corresponding protection plans for the member accounts in the organization.

• NEW : Indicates that when a new account joins the organization, they will have GuardDuty or any of the corresponding protection plans enabled automatically.
• ALL : Indicates that all accounts in the organization have GuardDuty and any of the corresponding protection plans enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.
• NONE : Indicates that GuardDuty or any of the corresponding protection plans will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually. When you update the auto-enable setting from ALL or NEW to NONE , this action doesn’t disable the corresponding option for your existing accounts. This configuration will apply to the new accounts that join the organization. After you update the auto-enable settings, no new account will have the corresponding option as enabled.