[ aws . securitylake ]
Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
See also: AWS API Documentation
get-subscriber --subscriber-id <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]
A value created by Amazon Security Lake that uniquely identifies your
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
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.
Turn on debug logging.
Override command’s default URL with the given URL.
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.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
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.
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.
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
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
subscriber -> (structure)
The subscriber information for the specified subscriber ID.
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
createdAt -> (timestamp)The date and time when the subscriber was created.
resourceShareArn -> (string)
The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.
This field is available only for Lake Formation subscribers created after March 8, 2023.
resourceShareName -> (string)The name of the resource share.
roleArn -> (string)The Amazon Resource Name (ARN) specifying the role of the subscriber.
s3BucketArn -> (string)The ARN for the Amazon S3 bucket.
sources -> (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 .
NoteThis is a Tagged Union structure. Only one of the following top level keys can be set:
awsLogSource -> (structure)
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
sourceName -> (string)The name for a Amazon Web Services source. This must be a Regionally unique value.
sourceVersion -> (string)The version for a Amazon Web Services source. This must be a Regionally unique value.
customLogSource -> (structure)
Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.
attributes -> (structure)
The attributes of a third-party custom source.
crawlerArn -> (string)The ARN of the Glue crawler.
databaseArn -> (string)The ARN of the Glue database where results are written, such as:
tableArn -> (string)The ARN of the Glue table.
provider -> (structure)
The details of the log provider for a third-party custom source.
location -> (string)The location of the partition in the Amazon S3 bucket for Security Lake.
roleArn -> (string)The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text ‘Security Lake’. The IAM role must trust the
logProviderAccountIdto assume the role.
sourceName -> (string)The name for a third-party custom source. This must be a Regionally unique value.
sourceVersion -> (string)The version for a third-party custom source. This must be a Regionally unique value.
subscriberArn -> (string)The subscriber ARN of the Amazon Security Lake subscriber account.
subscriberDescription -> (string)The subscriber descriptions for a subscriber account. The description for a subscriber includes
subscriberEndpoint -> (string)The subscriber endpoint to which exception messages are posted.
subscriberId -> (string)The subscriber ID of the Amazon Security Lake subscriber account.
subscriberIdentity -> (structure)
The AWS identity used to access your data.
externalId -> (string)The external ID used to estalish trust relationship with the AWS identity.
principal -> (string)The AWS identity principal.
subscriberName -> (string)The name of your Amazon Security Lake subscriber account.
subscriberStatus -> (string)The subscriber status of the Amazon Security Lake subscriber account.
updatedAt -> (timestamp)The date and time when the subscriber was last updated.