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

create-subscriber-notification

Description

Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake. You can create only one subscriber notification per subscriber.

See also: AWS API Documentation

Synopsis

  create-subscriber-notification
--configuration <value>
--subscriber-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

--configuration (tagged union structure)

Specify the configuration using which you want to create the subscriber notification.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: httpsNotificationConfiguration, sqsNotificationConfiguration.

httpsNotificationConfiguration -> (structure)

The configurations for HTTPS subscriber notification.

authorizationApiKeyName -> (string)

The key name for the notification subscription.

authorizationApiKeyValue -> (string)

The key value for the notification subscription.

endpoint -> (string)

The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.

httpMethod -> (string)

The HTTPS method used for the notification subscription.

targetRoleArn -> (string)

The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and Amazon Web Services Managed Policies in the Amazon Security Lake User Guide .

sqsNotificationConfiguration -> (structure)

The configurations for SQS subscriber notification.

Shorthand Syntax:

httpsNotificationConfiguration={authorizationApiKeyName=string,authorizationApiKeyValue=string,endpoint=string,httpMethod=string,targetRoleArn=string},sqsNotificationConfiguration={}

JSON Syntax:

{
  "httpsNotificationConfiguration": {
    "authorizationApiKeyName": "string",
    "authorizationApiKeyValue": "string",
    "endpoint": "string",
    "httpMethod": "POST"|"PUT",
    "targetRoleArn": "string"
  },
  "sqsNotificationConfiguration": {

  }
}

--subscriber-id (string)

The subscriber ID for the notification subscription.

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

subscriberEndpoint -> (string)

The subscriber endpoint to which exception messages are posted.