Amazon Config #X Amz Target=StarlingDoveService.PutOrganizationConformancePack 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.PutOrganizationConformancePack 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.PutOrganizationConformancePack'
paths:
  /#X-Amz-Target=StarlingDoveService.PutOrganizationConformancePack:
    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: PutOrganizationConformancePack
      description: '<p>Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html"> <b>Service Limits</b> </a> in the <i>Config Developer Guide</i>.</p> <p>Only a management account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p> <p>This API enables organization service access for <code>config-multiaccountsetup.amazonaws.com</code> through the <code>EnableAWSServiceAccess</code> action and creates a service-linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization <code>register-delegate-admin</code> for <code>config-multiaccountsetup.amazonaws.com</code>.</p> <note> <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p> <p>You must specify either the <code>TemplateS3Uri</code> or the <code>TemplateBody</code> parameter, but not both. If you provide both Config uses the <code>TemplateS3Uri</code> parameter and ignores the <code>TemplateBody</code> parameter.</p> <p>Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.</p> </note>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutOrganizationConformancePackResponse'
              examples:
                PutOrganizationConformancePack200Example:
                  summary: Default PutOrganizationConformancePack 200
                  x-microcks-default: true
                  value:
                    OrganizationConformancePackArn: example
        '480':
          description: MaxNumberOfOrganizationConformancePacksExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaxNumberOfOrganizationConformancePacksExceededException'
              examples:
                PutOrganizationConformancePack480Example:
                  summary: Default PutOrganizationConformancePack 480
                  x-microcks-default: true
                  value: example
        '481':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
              examples:
                PutOrganizationConformancePack481Example:
                  summary: Default PutOrganizationConformancePack 481
                  x-microcks-default: true
                  value: example
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                PutOrganizationConformancePack482Example:
                  summary: Default PutOrganizationConformancePack 482
                  x-microcks-default: true
                  value: example
        '483':
          description: OrganizationAccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationAccessDeniedException'
              examples:
                PutOrganizationConformancePack483Example:
                  summary: Default PutOrganizationConformancePack 483
                  x-microcks-default: true
                  value: example
        '484':
          description: InsufficientPermissionsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsufficientPermissionsException'
              examples:
                PutOrganizationConformancePack484Example:
                  summary: Default PutOrganizationConformancePack 484
                  x-microcks-default: true
                  value: example
        '485':
          description: OrganizationConformancePackTemplateValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationConformancePackTemplateValidationException'
              examples:
                PutOrganizationConformancePack485Example:
                  summary: Default PutOrganizationConformancePack 485
                  x-microcks-default: true
                  value: example
        '486':
          description: OrganizationAllFeaturesNotEnabledException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationAllFeaturesNotEnabledException'
              examples:
                PutOrganizationConformancePack486Example:
                  summary: Default PutOrganizationConformancePack 486
                  x-microcks-default: true
                  value: example
        '487':
          description: NoAvailableOrganizationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoAvailableOrganizationException'
              examples:
                PutOrganizationConformancePack487Example:
                  summary: Default PutOrganizationConformancePack 487
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutOrganizationConformancePackRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - StarlingDoveService.PutOrganizationConformancePack
      summary: Amazon Config Put Organization Conformance Pack
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.PutOrganizationConformancePack'
components:
  schemas:
    ResourceInUseException: {}
    DeliveryS3KeyPrefix:
      type: string
      minLength: 0
      maxLength: 1024
    StringWithCharLimit256:
      type: string
      minLength: 1
      maxLength: 256
    ParameterName:
      type: string
      minLength: 0
      maxLength: 255
    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
    MaxNumberOfOrganizationConformancePacksExceededException: {}
    OrganizationConformancePackTemplateValidationException: {}
    InsufficientPermissionsException: {}
    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.
    PutOrganizationConformancePackResponse:
      type: object
      properties:
        OrganizationConformancePackArn:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: ARN of the organization conformance pack.
    PutOrganizationConformancePackRequest:
      type: object
      required:
      - OrganizationConformancePackName
      title: PutOrganizationConformancePackRequest
      properties:
        OrganizationConformancePackName:
          allOf:
          - $ref: '#/components/schemas/OrganizationConformancePackName'
          - description: Name of the organization conformance pack you want to create.
        TemplateS3Uri:
          allOf:
          - $ref: '#/components/schemas/TemplateS3Uri'
          - description: '<p>Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).</p> <note> <p>You must have access to read Amazon S3 bucket.</p> </note>'
        TemplateBody:
          allOf:
          - $ref: '#/components/schemas/TemplateBody'
          - description: A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
        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. If used, it must be prefixed with <code>awsconfigconforms</code>.</p> </note>
        DeliveryS3KeyPrefix:
          allOf:
          - $ref: '#/components/schemas/DeliveryS3KeyPrefix'
          - description: <p>The prefix for the 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 list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.
    OrganizationAllFeaturesNotEnabledException: {}
    ParameterValue:
      type: string
      minLength: 0
      maxLength: 4096
    ConformancePackInputParameters:
      type: array
      items:
        $ref: '#/components/schemas/ConformancePackInputParameter'
      minItems: 0
      maxItems: 60
    NoAvailableOrganizationException: {}
    TemplateBody:
      type: string
      minLength: 1
      maxLength: 51200
    TemplateS3Uri:
      type: string
      pattern: s3://.*
      minLength: 1
      maxLength: 1024
    AccountId:
      type: string
      pattern: \d{12}
    OrganizationAccessDeniedException: {}
    ValidationException: {}
  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