AWS CLI Command Reference

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 . cognito-idp ]

get-log-delivery-configuration

Description

Gets the logging configuration of a user pool.

See also: AWS API Documentation

Synopsis

  get-log-delivery-configuration
--user-pool-id <value>
[--cli-input-json <value>]
[--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>]

Options

--user-pool-id (string)

The ID of the user pool that has the logging configuration that you want to view.

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

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

Output

LogDeliveryConfiguration -> (structure)

The logging configuration of the requested user pool.

UserPoolId -> (string)

The ID of the user pool where you configured logging.

LogConfigurations -> (list)

A logging destination of a user pool. User pools can have multiple logging destinations for message-delivery and user-activity logs.

(structure)

The logging parameters of a user pool.

LogLevel -> (string)

The errorlevel selection of logs that a user pool sends for detailed activity logging. To send userNotification activity with information about message delivery , choose ERROR with CloudWatchLogsConfiguration . To send userAuthEvents activity with user logs from advanced security features, choose INFO with one of CloudWatchLogsConfiguration , FirehoseConfiguration , or S3Configuration .

EventSource -> (string)

The source of events that your user pool sends for logging. To send error-level logs about user notification activity, set to userNotification . To send info-level logs about advanced security features user activity, set to userAuthEvents .

CloudWatchLogsConfiguration -> (structure)

The CloudWatch log group destination of user pool detailed activity logs, or of user activity log export with advanced security features.

LogGroupArn -> (string)

The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs. The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account as your user pool.

To send logs to log groups with a resource policy of a size greater than 5120 characters, configure a log group with a path that starts with /aws/vendedlogs . For more information, see Enabling logging from certain Amazon Web Services services .

S3Configuration -> (structure)

The Amazon S3 bucket destination of user activity log export with advanced security features. To activate this setting, advanced security features must be active in your user pool.

BucketArn -> (string)

The ARN of an Amazon S3 bucket that's the destination for advanced security features log export.

FirehoseConfiguration -> (structure)

The Amazon Data Firehose stream destination of user activity log export with advanced security features. To activate this setting, advanced security features must be active in your user pool.

StreamArn -> (string)

The ARN of an Amazon Data Firehose stream that's the destination for advanced security features log export.