Amazon Config #X Amz Target=StarlingDoveService.DescribeConfigurationAggregators API

openapi: 3.0.0
info:
  version: '2014-11-12'
  x-release: v4
  title: 'AWS Config #X Amz Target=StarlingDoveService.BatchGetAggregateResourceConfig #X Amz Target=StarlingDoveService.BatchGetAggregateResourceConfig #X Amz Target=StarlingDoveService.DescribeConfigurationAggregators API'
  description: <fullname>Config</fullname> <p>Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account. You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by Config, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported Amazon Web Services resources</a>.</p> <p>You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. For detailed information about Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html">What Is Config</a> in the <i>Config Developer Guide</i>.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: config
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/config-2014-11-12.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://config.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Config Service multi-region endpoint
- url: https://config.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Config Service multi-region endpoint
- url: http://config.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Config Service endpoint for China (Beijing) and China (Ningxia)
- url: https://config.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Config Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=StarlingDoveService.DescribeConfigurationAggregators'
paths:
  /#X-Amz-Target=StarlingDoveService.DescribeConfigurationAggregators:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: DescribeConfigurationAggregators
      description: 'Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConfigurationAggregatorsResponse'
              examples:
                DescribeConfigurationAggregators200Example:
                  summary: Default DescribeConfigurationAggregators 200
                  x-microcks-default: true
                  value:
                    ConfigurationAggregators: example
                    NextToken: example
        '480':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
              examples:
                DescribeConfigurationAggregators480Example:
                  summary: Default DescribeConfigurationAggregators 480
                  x-microcks-default: true
                  value: example
        '481':
          description: NoSuchConfigurationAggregatorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchConfigurationAggregatorException'
              examples:
                DescribeConfigurationAggregators481Example:
                  summary: Default DescribeConfigurationAggregators 481
                  x-microcks-default: true
                  value: example
        '482':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                DescribeConfigurationAggregators482Example:
                  summary: Default DescribeConfigurationAggregators 482
                  x-microcks-default: true
                  value: example
        '483':
          description: InvalidLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLimitException'
              examples:
                DescribeConfigurationAggregators483Example:
                  summary: Default DescribeConfigurationAggregators 483
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConfigurationAggregatorsRequest'
      parameters:
      - name: Limit
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - StarlingDoveService.DescribeConfigurationAggregators
      summary: Amazon Config Describe Configuration Aggregators
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.DescribeConfigurationAggregators'
components:
  schemas:
    NoSuchConfigurationAggregatorException: {}
    StringWithCharLimit256:
      type: string
      minLength: 1
      maxLength: 256
    ConfigurationAggregator:
      type: object
      properties:
        ConfigurationAggregatorName:
          allOf:
          - $ref: '#/components/schemas/ConfigurationAggregatorName'
          - description: The name of the aggregator.
        ConfigurationAggregatorArn:
          allOf:
          - $ref: '#/components/schemas/ConfigurationAggregatorArn'
          - description: The Amazon Resource Name (ARN) of the aggregator.
        AccountAggregationSources:
          allOf:
          - $ref: '#/components/schemas/AccountAggregationSourceList'
          - description: Provides a list of source accounts and regions to be aggregated.
        OrganizationAggregationSource:
          allOf:
          - $ref: '#/components/schemas/OrganizationAggregationSource'
          - description: Provides an organization and list of regions to be aggregated.
        CreationTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time stamp when the configuration aggregator was created.
        LastUpdatedTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time of the last update.
        CreatedBy:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: Amazon Web Services service that created the configuration aggregator.
      description: 'The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator. '
    Date:
      type: string
      format: date-time
    ConfigurationAggregatorArn:
      type: string
      pattern: arn:aws[a-z\-]*:config:[a-z\-\d]+:\d+:config-aggregator/config-aggregator-[a-z\d]+
    AccountAggregationSourceAccountList:
      type: array
      items:
        $ref: '#/components/schemas/AccountId'
      minItems: 1
    DescribeConfigurationAggregatorsResponse:
      type: object
      properties:
        ConfigurationAggregators:
          allOf:
          - $ref: '#/components/schemas/ConfigurationAggregatorList'
          - description: Returns a ConfigurationAggregators object.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.
    InvalidNextTokenException: {}
    InvalidParameterValueException: {}
    AccountAggregationSource:
      type: object
      required:
      - AccountIds
      properties:
        AccountIds:
          allOf:
          - $ref: '#/components/schemas/AccountAggregationSourceAccountList'
          - description: 'The 12-digit account ID of the account being aggregated. '
        AllAwsRegions:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: If true, aggregate existing Config regions and future regions.
        AwsRegions:
          allOf:
          - $ref: '#/components/schemas/AggregatorRegionList'
          - description: The source regions being aggregated.
      description: A collection of accounts and regions.
    Limit:
      type: integer
      minimum: 0
      maximum: 100
    ConfigurationAggregatorList:
      type: array
      items:
        $ref: '#/components/schemas/ConfigurationAggregator'
    InvalidLimitException: {}
    AggregatorRegionList:
      type: array
      items:
        $ref: '#/components/schemas/String'
      minItems: 1
    ConfigurationAggregatorName:
      type: string
      pattern: '[\w\-]+'
      minLength: 1
      maxLength: 256
    String:
      type: string
    Boolean:
      type: boolean
    AccountAggregationSourceList:
      type: array
      items:
        $ref: '#/components/schemas/AccountAggregationSource'
      minItems: 0
      maxItems: 1
    AccountId:
      type: string
      pattern: \d{12}
    DescribeConfigurationAggregatorsRequest:
      type: object
      title: DescribeConfigurationAggregatorsRequest
      properties:
        ConfigurationAggregatorNames:
          allOf:
          - $ref: '#/components/schemas/ConfigurationAggregatorNameList'
          - description: The name of the configuration aggregators.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.
        Limit:
          allOf:
          - $ref: '#/components/schemas/Limit'
          - description: The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default.
    ConfigurationAggregatorNameList:
      type: array
      items:
        $ref: '#/components/schemas/ConfigurationAggregatorName'
      minItems: 0
      maxItems: 10
    OrganizationAggregationSource:
      type: object
      required:
      - RoleArn
      properties:
        RoleArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.
        AwsRegions:
          allOf:
          - $ref: '#/components/schemas/AggregatorRegionList'
          - description: The source regions being aggregated.
        AllAwsRegions:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: If true, aggregate existing Config regions and future regions.
      description: This object contains regions to set up the aggregator and an IAM role to retrieve organization details.
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/config/
x-hasEquivalentPaths: true