SecurityLake / Client / list_subscribers

list_subscribers

SecurityLake.Client.list_subscribers(**kwargs)

List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_subscribers(
    maxResults=123,
    nextToken='string'
)

Parameters:

• maxResults (integer) – The maximum number of accounts for which the configuration is displayed.

• nextToken (string) – If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'subscribers': [
        {
            'accessTypes': [
                'LAKEFORMATION'|'S3',
            ],
            'accountId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'externalId': 'string',
            'resourceShareArn': 'string',
            'resourceShareName': 'string',
            'roleArn': 'string',
            's3BucketArn': 'string',
            'snsArn': 'string',
            'sourceTypes': [
                {
                    'awsSourceType': 'ROUTE53'|'VPC_FLOW'|'CLOUD_TRAIL'|'SH_FINDINGS',
                    'customSourceType': 'string'
                },
            ],
            'subscriberDescription': 'string',
            'subscriberName': 'string',
            'subscriptionEndpoint': 'string',
            'subscriptionId': 'string',
            'subscriptionProtocol': 'HTTPS'|'SQS',
            'subscriptionStatus': 'ACTIVE'|'DEACTIVATED'|'PENDING'|'READY',
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.

  • subscribers (list) –

    The subscribers available for the specified Security Lake account ID.

    • (dict) –

      Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.

      • 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 (datetime) –

        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.

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

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

        • (dict) –

          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 will be set: awsSourceType, customSourceType. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          

          • 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 (datetime) –

        The date and time when the subscription was created.

Exceptions

• SecurityLake.Client.exceptions.InternalServerException

• SecurityLake.Client.exceptions.ValidationException

• SecurityLake.Client.exceptions.AccessDeniedException

• SecurityLake.Client.exceptions.ResourceNotFoundException

• SecurityLake.Client.exceptions.AccountNotFoundException

• SecurityLake.Client.exceptions.InvalidInputException