Amazon GuardDuty Guardduty Publishingdestination API

openapi: 3.2.0
info:
  title: Amazon GuardDuty Publishingdestination API
  version: '2017-11-28'
  description: Generated from AWS's published Smithy model for Amazon GuardDuty. 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://guardduty.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Publishingdestination
paths:
  /detector/{DetectorId}/publishingDestination:
    post:
      operationId: CreatePublishingDestination
      summary: Create Publishing Destination
      description: Creates a publishing destination where you can export your GuardDuty findings. Before you start exporting the findings, the destination resource must exist.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePublishingDestinationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePublishingDestinationRequest'
      tags:
      - Publishingdestination
    get:
      operationId: ListPublishingDestinations
      summary: List Publishing Destinations
      description: Returns a list of publishing destinations associated with the specified detectorId.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPublishingDestinationsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListPublishingDestinationsRequest'
      tags:
      - Publishingdestination
  /detector/{DetectorId}/publishingDestination/{DestinationId}:
    delete:
      operationId: DeletePublishingDestination
      summary: Delete Publishing Destination
      description: Deletes the publishing definition with the specified destinationId.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePublishingDestinationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeletePublishingDestinationRequest'
      tags:
      - Publishingdestination
    get:
      operationId: DescribePublishingDestination
      summary: Describe Publishing Destination
      description: Returns information about the publishing destination specified by the provided destinationId.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribePublishingDestinationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribePublishingDestinationRequest'
      tags:
      - Publishingdestination
    post:
      operationId: UpdatePublishingDestination
      summary: Update Publishing Destination
      description: Updates information about the publishing destination specified by the destinationId.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePublishingDestinationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePublishingDestinationRequest'
      tags:
      - Publishingdestination
components:
  schemas:
    InternalServerErrorException:
      type: object
      properties:
        Message:
          type: string
          description: The error message.
        Type:
          type: string
          description: The error type.
    ListPublishingDestinationsRequest:
      type: object
      properties:
        DetectorId:
          type: string
          description: The detector ID for which you want to retrieve the publishing destination. To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
        MaxResults:
          type: integer
          description: The maximum number of results to return in the response.
        NextToken:
          type: string
          description: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
      required:
      - DetectorId
    DescribePublishingDestinationRequest:
      type: object
      properties:
        DetectorId:
          type: string
          description: The unique ID of the detector associated with the publishing destination to retrieve. To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
        DestinationId:
          type: string
          description: The ID of the publishing destination to retrieve.
      required:
      - DetectorId
      - DestinationId
    Destination:
      type: object
      properties:
        DestinationId:
          type: string
          description: The unique ID of the publishing destination.
        DestinationType:
          type: string
          enum:
          - S3
          description: The type of resource used for the publishing destination. Currently, only Amazon S3 buckets are supported.
        Status:
          type: string
          enum:
          - PENDING_VERIFICATION
          - PUBLISHING
          - UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY
          - STOPPED
          description: The status of the publishing destination.
      required:
      - DestinationId
      - DestinationType
      - Status
    CreatePublishingDestinationRequest:
      type: object
      properties:
        DetectorId:
          type: string
          description: The ID of the GuardDuty detector associated with the publishing destination. To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
        DestinationType:
          type: string
          enum:
          - S3
          description: The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.
        DestinationProperties:
          $ref: '#/components/schemas/DestinationProperties'
        ClientToken:
          type: string
          description: The idempotency token for the request.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags to be added to a new publishing destination resource.
      required:
      - DetectorId
      - DestinationType
      - DestinationProperties
    UpdatePublishingDestinationResponse:
      type: object
      properties: {}
    CreatePublishingDestinationResponse:
      type: object
      properties:
        DestinationId:
          type: string
          description: The ID of the publishing destination that is created.
      required:
      - DestinationId
    ListPublishingDestinationsResponse:
      type: object
      properties:
        Destinations:
          type: array
          items:
            $ref: '#/components/schemas/Destination'
          description: A Destinations object that includes information about each publishing destination returned.
        NextToken:
          type: string
          description: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
      required:
      - Destinations
    DescribePublishingDestinationResponse:
      type: object
      properties:
        DestinationId:
          type: string
          description: The ID of the publishing destination.
        DestinationType:
          type: string
          enum:
          - S3
          description: The type of publishing destination. Currently, only Amazon S3 buckets are supported.
        Status:
          type: string
          enum:
          - PENDING_VERIFICATION
          - PUBLISHING
          - UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY
          - STOPPED
          description: The status of the publishing destination.
        PublishingFailureStartTimestamp:
          type: integer
          description: The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.
        DestinationProperties:
          $ref: '#/components/schemas/DestinationProperties'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags of the publishing destination resource.
      required:
      - DestinationId
      - DestinationType
      - Status
      - PublishingFailureStartTimestamp
      - DestinationProperties
    DeletePublishingDestinationRequest:
      type: object
      properties:
        DetectorId:
          type: string
          description: The unique ID of the detector associated with the publishing destination to delete. To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
        DestinationId:
          type: string
          description: The ID of the publishing destination to delete.
      required:
      - DetectorId
      - DestinationId
    DestinationProperties:
      type: object
      properties:
        DestinationArn:
          type: string
          description: 'The ARN of the resource to publish to. To specify an S3 bucket folder use the following format: arn:aws:s3:::DOC-EXAMPLE-BUCKET/myFolder/'
        KmsKeyArn:
          type: string
          description: The ARN of the KMS key to use for encryption.
        ExpectedBucketOwner:
          type: string
          description: 'The 12-digit Amazon Web Services account ID of the account that owns the Amazon S3 bucket specified in the DestinationArn parameter. When you provide this value, GuardDuty verifies that the specified account owns the bucket before it exports findings. If the account ID doesn''t match the actual owner of the bucket, GuardDuty doesn''t export findings to that bucket. This helps prevent GuardDuty from exporting your findings to a bucket that a different Amazon Web Services account owns (for example, if the original bucket was deleted and its name was later claimed by another account). If you don''t '
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
          description: The error message.
        Type:
          type: string
          description: The error type.
    UpdatePublishingDestinationRequest:
      type: object
      properties:
        DetectorId:
          type: string
          description: The ID of the detector associated with the publishing destinations to update. To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
        DestinationId:
          type: string
          description: The ID of the publishing destination to update.
        DestinationProperties:
          $ref: '#/components/schemas/DestinationProperties'
      required:
      - DetectorId
      - DestinationId
    DeletePublishingDestinationResponse:
      type: object
      properties: {}
  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: guardduty
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/guardduty/service/2017-11-28/guardduty-2017-11-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)