openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 145 kB
JSON
{"openapi":"3.0.0","info":{"version":"2019-10-09","x-release":"v4","title":"Amazon AppConfig","description":"<p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT devices.</p> <p>To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.</p> <p>During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version. </p> <p>AppConfig supports multiple use cases. Here are some examples:</p> <ul> <li> <p> <b>Feature flags</b>: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement. </p> </li> <li> <p> <b>Application tuning</b>: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic.</p> </li> <li> <p> <b>Allow list</b>: Use AppConfig to allow premium subscribers to access paid content. </p> </li> <li> <p> <b>Operational issues</b>: Use AppConfig to reduce stress on your application when a dependency or other external factor impacts the system.</p> </li> </ul> <p>This reference is intended to be used with the <a href=\"http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html\">AppConfig User Guide</a>.</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":"appconfig","x-aws-signingName":"appconfig","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/appconfig-2019-10-09.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},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/appconfig/"},"servers":[{"url":"http://appconfig.{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 AppConfig multi-region endpoint"},{"url":"https://appconfig.{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 AppConfig multi-region endpoint"},{"url":"http://appconfig.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AppConfig endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://appconfig.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AppConfig endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/applications":{"post":{"operationId":"CreateApplication","description":"Creates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"description":"A name for the application.","type":"string","minLength":1,"maxLength":64},"Description":{"description":"A description of the application.","type":"string","minLength":0,"maxLength":1024},"Tags":{"description":"Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"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"}],"get":{"operationId":"ListApplications","description":"Lists all applications in your Amazon Web Services account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Applications"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"max_results","in":"query","required":false,"description":"The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"next_token","in":"query","required":false,"description":"A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results. ","schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/applications/{ApplicationId}/configurationprofiles":{"post":{"operationId":"CreateConfigurationProfile","description":"<p>Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following:</p> <ul> <li> <p>Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store</p> </li> <li> <p>Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket</p> </li> <li> <p>Pipelines stored in CodePipeline</p> </li> <li> <p>Secrets stored in Secrets Manager</p> </li> <li> <p>Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store</p> </li> <li> <p>Configuration data in SSM documents stored in the Systems Manager document store</p> </li> </ul> <p>A configuration profile includes the following information:</p> <ul> <li> <p>The URI location of the configuration data.</p> </li> <li> <p>The Identity and Access Management (IAM) role that provides access to the configuration data.</p> </li> <li> <p>A validator for the configuration data. Available validators include either a JSON Schema or an Amazon Web Services Lambda function.</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html\">Create a Configuration and a Configuration Profile</a> in the <i>AppConfig User Guide</i>.</p>","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationProfile"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"ApplicationId","in":"path","required":true,"description":"The application ID.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","LocationUri"],"properties":{"Name":{"description":"A name for the configuration profile.","type":"string","minLength":1,"maxLength":128},"Description":{"description":"A description of the configuration profile.","type":"string","minLength":0,"maxLength":1024},"LocationUri":{"description":"<p>A URI to locate the configuration. You can specify the following:</p> <ul> <li> <p>For the AppConfig hosted configuration store and for feature flags, specify <code>hosted</code>.</p> </li> <li> <p>For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format <code>ssm-parameter://<parameter name></code> or the ARN.</p> </li> <li> <p>For an Secrets Manager secret, specify the URI in the following format: <code>secrets-manager</code>://<secret name>.</p> </li> <li> <p>For an Amazon S3 object, specify the URI in the following format: <code>s3://<bucket>/<objectKey> </code>. Here is an example: <code>s3://my-bucket/my-app/us-east-1/my-config.json</code> </p> </li> <li> <p>For an SSM document, specify either the document name in the format <code>ssm-document://<document name></code> or the Amazon Resource Name (ARN).</p> </li> </ul>","type":"string","minLength":1,"maxLength":2048},"RetrievalRoleArn":{"description":"<p>The ARN of an IAM role with permission to access the configuration at the specified <code>LocationUri</code>.</p> <important> <p>A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration. </p> </important>","type":"string","pattern":"^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\\d{12}:role[/].*)$","minLength":20,"maxLength":2048},"Validators":{"description":"A list of methods for validating the configuration.","type":"array","items":{"$ref":"#/components/schemas/Validator"},"minItems":0,"maxItems":2},"Tags":{"description":"Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"Type":{"description":"<p>The type of configurations contained in the profile. AppConfig supports <code>feature flags</code> and <code>freeform</code> configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for <code>Type</code>:</p> <p> <code>AWS.AppConfig.FeatureFlags</code> </p> <p> <code>AWS.Freeform</code> </p>","type":"string","pattern":"^[a-zA-Z\\.]+"}}}}}}},"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"}],"get":{"operationId":"ListConfigurationProfiles","description":"Lists the configuration profiles for an application.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationProfiles"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"ApplicationId","in":"path","required":true,"description":"The application ID.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}},{"name":"max_results","in":"query","required":false,"description":"The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"next_token","in":"query","required":false,"description":"A token to start the list. Use this token to get the next set of results.","schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"type","in":"query","required":false,"description":"A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a freeform configuration.","schema":{"type":"string","pattern":"^[a-zA-Z\\.]+"}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/deploymentstrategies":{"post":{"operationId":"CreateDeploymentStrategy","description":"Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentStrategy"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","DeploymentDurationInMinutes","GrowthFactor"],"properties":{"Name":{"description":"A name for the deployment strategy.","type":"string","minLength":1,"maxLength":64},"Description":{"description":"A description of the deployment strategy.","type":"string","minLength":0,"maxLength":1024},"DeploymentDurationInMinutes":{"description":"Total amount of time for a deployment to last.","type":"integer","minimum":0,"maximum":1440},"FinalBakeTimeInMinutes":{"description":"Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see <a href=\"https://docs.aws.amazon.com/appconfig/latest/userguide/getting-started-with-appconfig-cloudwatch-alarms-permissions.html\">Configuring permissions for rollback based on Amazon CloudWatch alarms</a> in the <i>AppConfig User Guide</i>.","type":"integer","minimum":0,"maximum":1440},"GrowthFactor":{"description":"The percentage of targets to receive a deployed configuration during each interval.","type":"number","format":"float","minimum":1,"maximum":100},"GrowthType":{"description":"<p>The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:</p> <p> <b>Linear</b>: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for <code>Step percentage</code>. For example, a linear deployment that uses a <code>Step percentage</code> of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.</p> <p> <b>Exponential</b>: For this type, AppConfig processes the deployment exponentially using the following formula: <code>G*(2^N)</code>. In this formula, <code>G</code> is the growth factor specified by the user and <code>N</code> is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:</p> <p> <code>2*(2^0)</code> </p> <p> <code>2*(2^1)</code> </p> <p> <code>2*(2^2)</code> </p> <p>Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.</p>","type":"string","enum":["LINEAR","EXPONENTIAL"]},"ReplicateTo":{"description":"Save the deployment strategy to a Systems Manager (SSM) document.","type":"string","enum":["NONE","SSM_DOCUMENT"]},"Tags":{"description":"Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"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"}],"get":{"operationId":"ListDeploymentStrategies","description":"Lists deployment strategies.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentStrategies"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"max_results","in":"query","required":false,"description":"The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"next_token","in":"query","required":false,"description":"A token to start the list. Use this token to get the next set of results.","schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/applications/{ApplicationId}/environments":{"post":{"operationId":"CreateEnvironment","description":"Creates an environment. For each application, you define one or more environments. An environment is a deployment group of AppConfig targets, such as applications in a <code>Beta</code> or <code>Production</code> environment. You can also define environments for application subcomponents such as the <code>Web</code>, <code>Mobile</code> and <code>Back-end</code> components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environment"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"ApplicationId","in":"path","required":true,"description":"The application ID.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"description":"A name for the environment.","type":"string","minLength":1,"maxLength":64},"Description":{"description":"A description of the environment.","type":"string","minLength":0,"maxLength":1024},"Monitors":{"description":"Amazon CloudWatch alarms to monitor during the deployment process.","type":"array","items":{"$ref":"#/components/schemas/Monitor"},"minItems":0,"maxItems":5},"Tags":{"description":"Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"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"}],"get":{"operationId":"ListEnvironments","description":"Lists the environments for an application.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Environments"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"ApplicationId","in":"path","required":true,"description":"The application ID.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}},{"name":"max_results","in":"query","required":false,"description":"The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"next_token","in":"query","required":false,"description":"A token to start the list. Use this token to get the next set of results.","schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/extensions":{"post":{"operationId":"CreateExtension","description":"<p>Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.</p> <p>You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For most use cases, to create your own extension, you must create an Lambda function to perform any computation and processing defined in the extension. For more information about extensions, see <a href=\"https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html\">Working with AppConfig extensions</a> in the <i>AppConfig User Guide</i>.</p>","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Extension"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"Latest-Version-Number","in":"header","required":false,"description":"You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","Actions"],"properties":{"Name":{"description":"A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.","type":"string","minLength":1,"maxLength":64},"Description":{"description":"Information about the extension.","type":"string","minLength":0,"maxLength":1024},"Actions":{"description":"The actions defined in the extension.","type":"object","minProperties":1,"maxProperties":5,"additionalProperties":{"$ref":"#/components/schemas/ActionList"}},"Parameters":{"description":"The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the <code>CreateExtensionAssociation</code> API action. For Lambda extension actions, these parameters are included in the Lambda request object.","type":"object","minProperties":1,"maxProperties":5,"additionalProperties":{"$ref":"#/components/schemas/Parameter"}},"Tags":{"description":"Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. ","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"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"}],"get":{"operationId":"ListExtensions","description":"Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see <a href=\"https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html\">Working with AppConfig extensions</a> in the <i>AppConfig User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Extensions"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"max_results","in":"query","required":false,"description":"The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"next_token","in":"query","required":false,"description":"A token to start the list. Use this token to get the next set of results. ","schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"name","in":"query","required":false,"description":"The extension name.","schema":{"type":"string","minLength":1,"maxLength":64}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/extensionassociations":{"post":{"operationId":"CreateExtensionAssociation","description":"When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the <code>AppConfig deployment events to Amazon SNS</code> Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an <i>extension association</i>. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see <a href=\"https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html\">Working with AppConfig extensions</a> in the <i>AppConfig User Guide</i>.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionAssociation"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ExtensionIdentifier","ResourceIdentifier"],"properties":{"ExtensionIdentifier":{"description":"The name, the ID, or the Amazon Resource Name (ARN) of the extension.","type":"string","minLength":1,"maxLength":2048},"ExtensionVersionNumber":{"description":"The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.","type":"integer"},"ResourceIdentifier":{"description":"The ARN of an application, configuration profile, or environment.","type":"string","minLength":1,"maxLength":2048},"Parameters":{"description":"The parameter names and values defined in the extensions. Extension parameters marked <code>Required</code> must be entered for this field.","type":"object","minProperties":0,"maxProperties":5,"additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And2048"}},"Tags":{"description":"Adds one or more tags for the specified extension association. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. ","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"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"}],"get":{"operationId":"ListExtensionAssociations","description":"Lists all AppConfig extension associations in the account. For more information about extensions and associations, see <a href=\"https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html\">Working with AppConfig extensions</a> in the <i>AppConfig User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionAssociations"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"resource_identifier","in":"query","required":false,"description":"The ARN of an application, configuration profile, or environment.","schema":{"type":"string","pattern":"arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:[a-zA-Z0-9-_/:.]+","minLength":20,"maxLength":2048}},{"name":"extension_identifier","in":"query","required":false,"description":"The name, the ID, or the Amazon Resource Name (ARN) of the extension.","schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"extension_version_number","in":"query","required":false,"description":"The version number for the extension defined in the association.","schema":{"type":"integer"}},{"name":"max_results","in":"query","required":false,"description":"The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"next_token","in":"query","required":false,"description":"A token to start the list. Use this token to get the next set of results or pass null to get the first set of results. ","schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}/hostedconfigurationversions#Content-Type":{"post":{"operationId":"CreateHostedConfigurationVersion","description":"Creates a new configuration in the AppConfig hosted configuration store.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostedConfigurationVersion"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"485":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"ApplicationId","in":"path","required":true,"description":"The application ID.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}},{"name":"ConfigurationProfileId","in":"path","required":true,"description":"The configuration profile ID.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}},{"name":"Description","in":"header","required":false,"description":"A description of the configuration.","schema":{"type":"string","minLength":0,"maxLength":1024}},{"name":"Content-Type","in":"header","required":true,"description":"A standard MIME type describing the format of the configuration content. For more information, see <a href=\"https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17\">Content-Type</a>.","schema":{"type":"string","minLength":1,"maxLength":255}},{"name":"Latest-Version-Number","in":"header","required":false,"description":"An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.","schema":{"type":"integer"}},{"name":"VersionLabel","in":"header","required":false,"description":"An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, \"v2.2.0\".","schema":{"type":"string","pattern":".*[^0-9].*","minLength":1,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Content"],"properties":{"Content":{"description":"The content of the configuration or the configuration data.","type":"string","format":"password"}}}}}}},"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"}]},"/applications/{ApplicationId}":{"delete":{"operationId":"DeleteApplication","description":"Deletes an application. Deleting an application does not delete a configuration from a host.","responses":{"204":{"description":"Success"},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"ApplicationId","in":"path","required":true,"description":"The ID of the application to delete.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}}]},"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"}],"get":{"operationId":"GetApplication","description":"Retrieves information about an application.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"ApplicationId","in":"path","required":true,"description":"The ID of the application you want to get.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}}]},"patch":{"operationId":"UpdateApplication","description":"Updates an application.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"ApplicationId","in":"path","required":true,"description":"The application ID.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Name":{"description":"The name of the application.","type":"string","minLength":1,"maxLength":64},"Description":{"description":"A description of the application.","type":"string","minLength":0,"maxLength":1024}}}}}}}},"/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}":{"delete":{"operationId":"DeleteConfigurationProfile","description":"Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.","responses":{"204":{"description":"Success"},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"ApplicationId","in":"path","required":true,"description":"The application ID that includes the configuration profile you want to delete.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}},{"name":"ConfigurationProfileId","in":"path","required":true,"description":"The ID of the configuration profile you want to delete.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}}]},"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"}],"get":{"operationId":"GetConfigurationProfile","description":"Retrieves information about a configuration profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationProfile"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"ApplicationId","in":"path","required":true,"description":"The ID of the application that includes the configuration profile you want to get.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}},{"name":"ConfigurationProfileId","in":"path","required":true,"description":"The ID of the configuration profile that you want to get.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}}]},"patch":{"operationId":"UpdateConfigurationProfile","description":"Updates a configuration profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationProfile"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"ApplicationId","in":"path","required":true,"description":"The application ID.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}},{"name":"ConfigurationProfileId","in":"path","required":true,"description":"The ID of the configuration profile.","schema":{"type":"string","pattern":"[a-z0-9]{4,7}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Name":{"description":"The name of the configuration profile.","type":"string","minLength":1,"maxLength":64},"Description":{"description":"A description of the configuration profile.","type":"string","minLength":0,"maxLength":1024},"RetrievalRoleArn":{"description":"The ARN of an IAM role with permission to access the configuration at the specified <code>LocationUri</code>.","type":"string","pattern":"^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\\d{12}:role[/].*)$","minLength":20,"maxLength":2048},"Validators":{"description":"A list of methods for validating the configuration.","type":"array","items":{"$ref":"#/components/schemas/Validator"},"minItems":0,"maxItems":2}}}}}}}},"/deployementstrategies/{DeploymentStrategyId}":{"delete":{"operationId":"DeleteDeploymentStrategy","description":"Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.","responses":{"204":{"description":"Success"},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"DeploymentStrategyId","in":"path","required":true,"description":"The ID of the deployment strategy you want to delete.","schema":{"type":"string","pattern":"(^[a-z0-9]{4,7}$|^AppConfig\\.[A-Za-z0-9]{9,40}$)"}}]},"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"}]},"/applications/{ApplicationId}/environments/{EnvironmentId}":{"delete":{"operationId":"DeleteEnvironment","description":"Deletes an environment. Deleting an environment does not delete a configuration from a host.","responses":{"204":{"description":"Success"},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"BadRequestExcept