Amazon Security Lake Subscribers API

openapi: 3.1.0
info:
  title: Amazon Security Lake Subscribers API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for Amazon Security Lake. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://securitylake.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /v1/subscribers:
    post:
      operationId: CreateSubscriber
      summary: Create Subscriber
      description: Creates a subscriber for accounts that are already enabled in Amazon Security Lake. You can create a subscriber
        with access to data in the current Amazon Web Services Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriberResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriberRequest'
      tags:
      - Subscribers
    get:
      operationId: ListSubscribers
      summary: List Subscribers
      description: Lists 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSubscribersResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSubscribersRequest'
      tags:
      - Subscribers
  /v1/subscribers/{subscriberId}:
    get:
      operationId: GetSubscriber
      summary: Get Subscriber
      description: Retrieves the subscription information for the specified subscription ID. You can get information about
        a specific subscriber.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriberResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSubscriberRequest'
      tags:
      - Subscribers
    put:
      operationId: UpdateSubscriber
      summary: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSubscriberResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriberRequest'
      tags:
      - Subscribers
    delete:
      operationId: DeleteSubscriber
      summary: Delete Subscriber
      description: Deletes the subscription permission and all notification settings for accounts that are already enabled
        in Amazon Security Lake. When you run DeleteSubscriber, the subscriber will no longer consume data from Security Lake
        and the subscriber is removed. This operation deletes the subscriber and removes access to data in the current Amazon
        Web Services Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSubscriberResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteSubscriberRequest'
      tags:
      - Subscribers
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: securitylake
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
        errorCode:
          type: string
          description: A coded string to provide more information about the access denied exception. You can use the error
            code to check the exception type.
    AwsIdentity:
      type: object
      properties:
        principal:
          type: string
          description: The Amazon Web Services identity principal.
        externalId:
          type: string
          description: The external ID used to establish trust relationship with the Amazon Web Services identity.
      required:
      - principal
      - externalId
    AwsLogSourceResource:
      type: object
      properties:
        sourceName:
          type: string
          enum:
          - ROUTE53
          - VPC_FLOW
          - SH_FINDINGS
          - CLOUD_TRAIL_MGMT
          - LAMBDA_EXECUTION
          - S3_DATA
          - EKS_AUDIT
          - WAF
          description: The name for a Amazon Web Services source. This must be a Regionally unique value.
        sourceVersion:
          type: string
          description: The version for a Amazon Web Services source. This must be a Regionally unique value.
    BadRequestException:
      type: object
      properties:
        message:
          type: string
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The resource name.
        resourceType:
          type: string
          description: The resource type.
    CreateSubscriberRequest:
      type: object
      properties:
        subscriberIdentity:
          $ref: '#/components/schemas/AwsIdentity'
        subscriberName:
          type: string
          description: The name of your Security Lake subscriber account.
        subscriberDescription:
          type: string
          description: The description for your subscriber account in Security Lake.
        sources:
          type: array
          items:
            $ref: '#/components/schemas/LogSourceResource'
          description: The supported Amazon Web Services services from which logs and events are collected. Security Lake
            supports log and event collection for natively supported Amazon Web Services services.
        accessTypes:
          type: array
          items:
            type: string
            enum:
            - LAKEFORMATION
            - S3
          description: The Amazon S3 or Lake Formation access type.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify
            both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
      required:
      - subscriberIdentity
      - subscriberName
      - sources
    CreateSubscriberResponse:
      type: object
      properties:
        subscriber:
          $ref: '#/components/schemas/SubscriberResource'
    CustomLogSourceAttributes:
      type: object
      properties:
        crawlerArn:
          type: string
          description: The ARN of the Glue crawler.
        databaseArn:
          type: string
          description: 'The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.'
        tableArn:
          type: string
          description: The ARN of the Glue table.
    CustomLogSourceProvider:
      type: object
      properties:
        roleArn:
          type: string
          description: 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 logProviderAccountId
            to assume the role.
        location:
          type: string
          description: The location of the partition in the Amazon S3 bucket for Security Lake.
    CustomLogSourceResource:
      type: object
      properties:
        sourceName:
          type: string
          description: The name for a third-party custom source. This must be a Regionally unique value.
        sourceVersion:
          type: string
          description: The version for a third-party custom source. This must be a Regionally unique value.
        provider:
          $ref: '#/components/schemas/CustomLogSourceProvider'
        attributes:
          $ref: '#/components/schemas/CustomLogSourceAttributes'
    DeleteSubscriberRequest:
      type: object
      properties:
        subscriberId:
          type: string
          description: A value created by Security Lake that uniquely identifies your DeleteSubscriber API request.
      required:
      - subscriberId
    DeleteSubscriberResponse:
      type: object
      properties: {}
    GetSubscriberRequest:
      type: object
      properties:
        subscriberId:
          type: string
          description: A value created by Amazon Security Lake that uniquely identifies your GetSubscriber API request.
      required:
      - subscriberId
    GetSubscriberResponse:
      type: object
      properties:
        subscriber:
          $ref: '#/components/schemas/SubscriberResource'
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListSubscribersRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: If nextToken is returned, there are more results available. You can repeat the call using the returned
            token to retrieve the next page.
        maxResults:
          type: integer
          description: The maximum number of accounts for which the configuration is displayed.
    ListSubscribersResponse:
      type: object
      properties:
        subscribers:
          type: array
          items:
            $ref: '#/components/schemas/SubscriberResource'
          description: The subscribers available for the specified Security Lake account ID.
        nextToken:
          type: string
          description: If nextToken is returned, there are more results available. You can repeat the call using the returned
            token to retrieve the next page.
    LogSourceResource:
      type: object
      properties:
        awsLogSource:
          $ref: '#/components/schemas/AwsLogSourceResource'
        customLogSource:
          $ref: '#/components/schemas/CustomLogSourceResource'
      description: Exactly one member is set.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The name of the resource that could not be found.
        resourceType:
          type: string
          description: The type of the resource that could not be found.
    SubscriberResource:
      type: object
      properties:
        subscriberId:
          type: string
          description: The subscriber ID of the Amazon Security Lake subscriber account.
        subscriberArn:
          type: string
          description: The subscriber ARN of the Amazon Security Lake subscriber account.
        subscriberIdentity:
          $ref: '#/components/schemas/AwsIdentity'
        subscriberName:
          type: string
          description: The name of your Amazon Security Lake subscriber account.
        subscriberDescription:
          type: string
          description: The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName,
            accountID, externalID, and subscriberId.
        sources:
          type: array
          items:
            $ref: '#/components/schemas/LogSourceResource'
          description: Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services.
            For more information, see the Amazon Security Lake User Guide.
        accessTypes:
          type: array
          items:
            type: string
            enum:
            - LAKEFORMATION
            - S3
          description: 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.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) specifying the role of the subscriber.
        s3BucketArn:
          type: string
          description: The ARN for the Amazon S3 bucket.
        subscriberEndpoint:
          type: string
          description: The subscriber endpoint to which exception messages are posted.
        subscriberStatus:
          type: string
          enum:
          - ACTIVE
          - DEACTIVATED
          - PENDING
          - READY
          description: The subscriber status of the Amazon Security Lake subscriber account.
        resourceShareArn:
          type: string
          description: The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services 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:
          type: string
          description: The name of the resource share.
        createdAt:
          type: string
          description: The date and time when the subscriber was created.
        updatedAt:
          type: string
          description: The date and time when the subscriber was last updated.
      required:
      - subscriberId
      - subscriberArn
      - subscriberIdentity
      - subscriberName
      - sources
    Tag:
      type: object
      properties:
        key:
          type: string
          description: The name of the tag. This is a general label that acts as a category for a more specific tag value
            (value).
        value:
          type: string
          description: The value that’s associated with the specified tag key (key). This value acts as a descriptor for the
            tag key. A tag value cannot be null, but it can be an empty string.
      required:
      - key
      - value
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        serviceCode:
          type: string
          description: The code for the service in Service Quotas.
        quotaCode:
          type: string
          description: That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services
            account.
        retryAfterSeconds:
          type: integer
          description: Retry the request after the specified time.
    UpdateSubscriberRequest:
      type: object
      properties:
        subscriberId:
          type: string
          description: A value created by Security Lake that uniquely identifies your subscription.
        subscriberIdentity:
          $ref: '#/components/schemas/AwsIdentity'
        subscriberName:
          type: string
          description: The name of the Security Lake account subscriber.
        subscriberDescription:
          type: string
          description: The description of the Security Lake account subscriber.
        sources:
          type: array
          items:
            $ref: '#/components/schemas/LogSourceResource'
          description: The supported Amazon Web Services services from which logs and events are collected. For the list of
            supported Amazon Web Services services, see the Amazon Security Lake User Guide.
      required:
      - subscriberId
    UpdateSubscriberResponse:
      type: object
      properties:
        subscriber:
          $ref: '#/components/schemas/SubscriberResource'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/securitylake/service/2018-05-10/securitylake-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)