AWS Security Hub Security Hub Findingaggregator API

openapi: 3.2.0
info:
  title: AWS SecurityHub Findingaggregator API
  version: '2018-10-26'
  description: Generated from AWS's published Smithy model for AWS SecurityHub. 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://securityhub.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Findingaggregator
paths:
  /findingAggregator/create:
    post:
      operationId: CreateFindingAggregator
      summary: Create Finding Aggregator
      description: The aggregation Region is now called the home Region. Used to enable cross-Region aggregation. This operation can be invoked from the home Region only. For information about how cross-Region aggregation works, see Understanding cross-Region aggregation in Security Hub CSPM in the Security Hub CSPM User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFindingAggregatorResponse'
              example:
                FindingAggregatorArn: arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                FindingAggregationRegion: us-east-1
                RegionLinkingMode: SPECIFIED_REGIONS
                Regions:
                - us-west-1
                - us-west-2
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '400':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFindingAggregatorRequest'
            example:
              RegionLinkingMode: SPECIFIED_REGIONS
              Regions:
              - us-west-1
              - us-west-2
      tags:
      - Findingaggregator
  /findingAggregator/delete/{FindingAggregatorArn+}:
    delete:
      operationId: DeleteFindingAggregator
      summary: Delete Finding Aggregator
      description: The aggregation Region is now called the home Region. Deletes a finding aggregator. When you delete the finding aggregator, you stop cross-Region aggregation. Finding replication stops occurring from the linked Regions to the home Region. When you stop cross-Region aggregation, findings that were already replicated and sent to the home Region are still visible from the home Region. However, new findings and finding updates are no longer replicated and sent to the home Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFindingAggregatorResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '400':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFindingAggregatorRequest'
            example:
              FindingAggregatorArn: arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
      tags:
      - Findingaggregator
  /findingAggregator/get/{FindingAggregatorArn+}:
    get:
      operationId: GetFindingAggregator
      summary: Get Finding Aggregator
      description: The aggregation Region is now called the home Region. Returns the current configuration in the calling account for cross-Region aggregation. A finding aggregator is a resource that establishes the home Region and any linked Regions.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFindingAggregatorResponse'
              example:
                FindingAggregatorArn: arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                FindingAggregationRegion: us-east-1
                RegionLinkingMode: SPECIFIED_REGIONS
                Regions:
                - us-west-1
                - us-west-2
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '400':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetFindingAggregatorRequest'
            example:
              FindingAggregatorArn: arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
      tags:
      - Findingaggregator
  /findingAggregator/list:
    get:
      operationId: ListFindingAggregators
      summary: List Finding Aggregators
      description: If cross-Region aggregation is enabled, then ListFindingAggregators returns the Amazon Resource Name (ARN) of the finding aggregator. You can run this operation from any Amazon Web Services Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFindingAggregatorsResponse'
              example:
                FindingAggregators:
                - FindingAggregatorArn: arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '400':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListFindingAggregatorsRequest'
      tags:
      - Findingaggregator
  /findingAggregator/update:
    patch:
      operationId: UpdateFindingAggregator
      summary: Update Finding Aggregator
      description: The aggregation Region is now called the home Region. Updates cross-Region aggregation settings. You can use this operation to update the Region linking mode and the list of included or excluded Amazon Web Services Regions. However, you can't use this operation to change the home Region. You can invoke this operation from the current home Region only.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFindingAggregatorResponse'
              example:
                FindingAggregatorArn: arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                FindingAggregationRegion: us-east-1
                RegionLinkingMode: SPECIFIED_REGIONS
                Regions:
                - us-west-1
                - us-west-2
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '400':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFindingAggregatorRequest'
            example:
              FindingAggregatorArn: arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
              RegionLinkingMode: SPECIFIED_REGIONS
              Regions:
              - us-west-1
              - us-west-2
      tags:
      - Findingaggregator
components:
  schemas:
    InvalidInputException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    ListFindingAggregatorsResponse:
      type: object
      properties:
        FindingAggregators:
          type: array
          items:
            $ref: '#/components/schemas/FindingAggregator'
          description: The list of finding aggregators. This operation currently only returns a single result.
        NextToken:
          type: string
          description: If there are more results, this is the token to provide in the next call to ListFindingAggregators. This operation currently only returns a single result.
    CreateFindingAggregatorRequest:
      type: object
      properties:
        RegionLinkingMode:
          type: string
          description: 'Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub CSPM supports them and you opt into them. The selected option also determines how to use the Regions provided in the Regions list. The options are as follows: ALL_REGIONS - Aggregates findings from all of the Regions where Security Hub CSPM is enabled. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into'
        Regions:
          type: array
          items:
            type: string
          description: If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region. If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region. An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.
      required:
      - RegionLinkingMode
    UpdateFindingAggregatorResponse:
      type: object
      properties:
        FindingAggregatorArn:
          type: string
          description: The ARN of the finding aggregator.
        FindingAggregationRegion:
          type: string
          description: The home Region. Findings generated in linked Regions are replicated and sent to the home Region.
        RegionLinkingMode:
          type: string
          description: Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
        Regions:
          type: array
          items:
            type: string
          description: The list of excluded Regions or included Regions.
    GetFindingAggregatorResponse:
      type: object
      properties:
        FindingAggregatorArn:
          type: string
          description: The ARN of the finding aggregator.
        FindingAggregationRegion:
          type: string
          description: The home Region. Findings generated in linked Regions are replicated and sent to the home Region.
        RegionLinkingMode:
          type: string
          description: Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
        Regions:
          type: array
          items:
            type: string
          description: The list of excluded Regions or included Regions.
    DeleteFindingAggregatorRequest:
      type: object
      properties:
        FindingAggregatorArn:
          type: string
          description: The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators.
      required:
      - FindingAggregatorArn
    GetFindingAggregatorRequest:
      type: object
      properties:
        FindingAggregatorArn:
          type: string
          description: The ARN of the finding aggregator to return details for. To obtain the ARN, use ListFindingAggregators.
      required:
      - FindingAggregatorArn
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    InternalException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    FindingAggregator:
      type: object
      properties:
        FindingAggregatorArn:
          type: string
          description: The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.
    UpdateFindingAggregatorRequest:
      type: object
      properties:
        FindingAggregatorArn:
          type: string
          description: The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.
        RegionLinkingMode:
          type: string
          description: 'Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub CSPM supports them and you opt into them. The selected option also determines how to use the Regions provided in the Regions list. The options are as follows: ALL_REGIONS - Aggregates findings from all of the Regions where Security Hub CSPM is enabled. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into'
        Regions:
          type: array
          items:
            type: string
          description: If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region. If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region. An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.
      required:
      - FindingAggregatorArn
      - RegionLinkingMode
    DeleteFindingAggregatorResponse:
      type: object
      properties: {}
    ListFindingAggregatorsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The token returned with the previous set of results. Identifies the next set of results to return.
        MaxResults:
          type: integer
          description: The maximum number of results to return. This operation currently only returns a single result.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    CreateFindingAggregatorResponse:
      type: object
      properties:
        FindingAggregatorArn:
          type: string
          description: The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop cross-Region aggregation.
        FindingAggregationRegion:
          type: string
          description: The home Region. Findings generated in linked Regions are replicated and sent to the home Region.
        RegionLinkingMode:
          type: string
          description: Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
        Regions:
          type: array
          items:
            type: string
          description: The list of excluded Regions or included Regions.
    InvalidAccessException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
  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: securityhub
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/securityhub/service/2018-10-26/securityhub-2018-10-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)