AWS CLI Command Reference

[ aws . securitylake ]

update-subscriber

Description

Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.

See also: AWS API Documentation

Synopsis

  update-subscriber
[--external-id <value>]
--id <value>
--source-types <value>
[--subscriber-description <value>]
[--subscriber-name <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

--external-id (string)

The external ID of the Security Lake account.

--id (string)

A value created by Security Lake that uniquely identifies your subscription.

--source-types (list)

The supported Amazon Web Services from which logs and events are collected. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide .

(tagged union structure)

The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide .

Note

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

awsSourceType -> (string)

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

customSourceType -> (string)

Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

Shorthand Syntax:

awsSourceType=string,customSourceType=string ...

JSON Syntax:

[
  {
    "awsSourceType": "ROUTE53"|"VPC_FLOW"|"CLOUD_TRAIL"|"SH_FINDINGS",
    "customSourceType": "string"
  }
  ...
]

--subscriber-description (string)

The description of the Security Lake account subscriber.

--subscriber-name (string)

The name of the Security Lake account subscriber.

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

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

subscriber -> (structure)

The account of the subscriber.

accessTypes -> (list)

You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .

(string)

accountId -> (string)

The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

createdAt -> (timestamp)

The date and time when the subscription was created.

externalId -> (string)

The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

roleArn -> (string)

The Amazon Resource Name (ARN) specifying the role of the subscriber.

s3BucketArn -> (string)

The ARN for the Amazon S3 bucket.

snsArn -> (string)

The ARN for the Amazon Simple Notification Service.

sourceTypes -> (list)

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

(tagged union structure)

The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide .

Note

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

awsSourceType -> (string)

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

customSourceType -> (string)

Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

subscriberDescription -> (string)

The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName , accountID , externalID , and subscriptionId .

subscriberName -> (string)

The name of your Amazon Security Lake subscriber account.

subscriptionEndpoint -> (string)

The subscription endpoint to which exception messages are posted.

subscriptionId -> (string)

The subscription ID of the Amazon Security Lake subscriber account.

subscriptionProtocol -> (string)

The subscription protocol to which exception messages are posted.

subscriptionStatus -> (string)

The subscription status of the Amazon Security Lake subscriber account.

updatedAt -> (timestamp)

The date and time when the subscription was created.

© Copyright 2018, Amazon Web Services. Created using Sphinx.