Amazon Config #X Amz Target=StarlingDoveService.DescribeOrganizationConformancePacks 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.DescribeOrganizationConformancePacks 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.DescribeOrganizationConformancePacks'
paths:
  /#X-Amz-Target=StarlingDoveService.DescribeOrganizationConformancePacks:
    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: DescribeOrganizationConformancePacks
      description: <p>Returns a list of organization conformance packs. </p> <note> <p>When you specify the limit and the next token, you receive a paginated response. </p> <p>Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs. </p> <p> <i>For accounts within an organzation</i> </p> <p>If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The <code>DescribeOrganizationConfigRules</code> and <code>DescribeOrganizationConformancePacks</code> APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeOrganizationConformancePacksResponse'
              examples:
                DescribeOrganizationConformancePacks200Example:
                  summary: Default DescribeOrganizationConformancePacks 200
                  x-microcks-default: true
                  value:
                    OrganizationConformancePacks: example
                    NextToken: example
        '480':
          description: NoSuchOrganizationConformancePackException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchOrganizationConformancePackException'
              examples:
                DescribeOrganizationConformancePacks480Example:
                  summary: Default DescribeOrganizationConformancePacks 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                DescribeOrganizationConformancePacks481Example:
                  summary: Default DescribeOrganizationConformancePacks 481
                  x-microcks-default: true
                  value: example
        '482':
          description: InvalidLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLimitException'
              examples:
                DescribeOrganizationConformancePacks482Example:
                  summary: Default DescribeOrganizationConformancePacks 482
                  x-microcks-default: true
                  value: example
        '483':
          description: OrganizationAccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationAccessDeniedException'
              examples:
                DescribeOrganizationConformancePacks483Example:
                  summary: Default DescribeOrganizationConformancePacks 483
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeOrganizationConformancePacksRequest'
      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.DescribeOrganizationConformancePacks
      summary: Amazon Config Describe Organization Conformance Packs
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.DescribeOrganizationConformancePacks'
components:
  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
  schemas:
    DeliveryS3KeyPrefix:
      type: string
      minLength: 0
      maxLength: 1024
    StringWithCharLimit256:
      type: string
      minLength: 1
      maxLength: 256
    ParameterName:
      type: string
      minLength: 0
      maxLength: 255
    DescribeOrganizationConformancePacksResponse:
      type: object
      properties:
        OrganizationConformancePacks:
          allOf:
          - $ref: '#/components/schemas/OrganizationConformancePacks'
          - description: Returns a list of OrganizationConformancePacks objects.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
    OrganizationConformancePacks:
      type: array
      items:
        $ref: '#/components/schemas/OrganizationConformancePack'
    OrganizationConformancePackName:
      type: string
      pattern: '[a-zA-Z][-a-zA-Z0-9]*'
      minLength: 1
      maxLength: 128
    ExcludedAccounts:
      type: array
      items:
        $ref: '#/components/schemas/AccountId'
      minItems: 0
      maxItems: 1000
    NoSuchOrganizationConformancePackException: {}
    Date:
      type: string
      format: date-time
    DeliveryS3Bucket:
      type: string
      minLength: 0
      maxLength: 63
    ConformancePackInputParameter:
      type: object
      required:
      - ParameterName
      - ParameterValue
      properties:
        ParameterName:
          allOf:
          - $ref: '#/components/schemas/ParameterName'
          - description: One part of a key-value pair.
        ParameterValue:
          allOf:
          - $ref: '#/components/schemas/ParameterValue'
          - description: 'Another part of the key-value pair. '
      description: Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.
    OrganizationConformancePack:
      type: object
      required:
      - OrganizationConformancePackName
      - OrganizationConformancePackArn
      - LastUpdateTime
      properties:
        OrganizationConformancePackName:
          allOf:
          - $ref: '#/components/schemas/OrganizationConformancePackName'
          - description: The name you assign to an organization conformance pack.
        OrganizationConformancePackArn:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: Amazon Resource Name (ARN) of organization conformance pack.
        DeliveryS3Bucket:
          allOf:
          - $ref: '#/components/schemas/DeliveryS3Bucket'
          - description: <p>The name of the Amazon S3 bucket where Config stores conformance pack templates. </p> <note> <p>This field is optional.</p> </note>
        DeliveryS3KeyPrefix:
          allOf:
          - $ref: '#/components/schemas/DeliveryS3KeyPrefix'
          - description: <p>Any folder structure you want to add to an Amazon S3 bucket.</p> <note> <p>This field is optional.</p> </note>
        ConformancePackInputParameters:
          allOf:
          - $ref: '#/components/schemas/ConformancePackInputParameters'
          - description: A list of <code>ConformancePackInputParameter</code> objects.
        ExcludedAccounts:
          allOf:
          - $ref: '#/components/schemas/ExcludedAccounts'
          - description: A comma-separated list of accounts excluded from organization conformance pack.
        LastUpdateTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: Last time when organization conformation pack was updated.
      description: 'An organization conformance pack that has information about conformance packs that Config creates in member accounts. '
    InvalidNextTokenException: {}
    DescribeOrganizationConformancePacksRequest:
      type: object
      title: DescribeOrganizationConformancePacksRequest
      properties:
        OrganizationConformancePackNames:
          allOf:
          - $ref: '#/components/schemas/OrganizationConformancePackNames'
          - description: The name that you assign to an organization conformance pack.
        Limit:
          allOf:
          - $ref: '#/components/schemas/CosmosPageLimit'
          - description: The maximum number of organization config packs returned on each page. If you do no specify a number, Config uses the default. The default is 100.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
    CosmosPageLimit:
      type: integer
      minimum: 0
      maximum: 100
    InvalidLimitException: {}
    ParameterValue:
      type: string
      minLength: 0
      maxLength: 4096
    OrganizationConformancePackNames:
      type: array
      items:
        $ref: '#/components/schemas/OrganizationConformancePackName'
      minItems: 0
      maxItems: 25
    String:
      type: string
    ConformancePackInputParameters:
      type: array
      items:
        $ref: '#/components/schemas/ConformancePackInputParameter'
      minItems: 0
      maxItems: 60
    AccountId:
      type: string
      pattern: \d{12}
    OrganizationAccessDeniedException: {}
  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