UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 330 kB
{"openapi":"3.0.0","info":{"version":"2010-12-01","x-release":"v4","title":"AWS Elastic Beanstalk","description":"<fullname>AWS Elastic Beanstalk</fullname> <p>AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.</p> <p>For more information about this product, go to the <a href=\"http://aws.amazon.com/elasticbeanstalk/\">AWS Elastic Beanstalk</a> details page. The location of the latest AWS Elastic Beanstalk WSDL is <a href=\"https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl\">https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl</a>. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> <p> <b>Endpoints</b> </p> <p>For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region\">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</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":"elasticbeanstalk","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/elasticbeanstalk-2010-12-01.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/elasticbeanstalk/"},"servers":[{"url":"http://elasticbeanstalk.{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 Elastic Beanstalk multi-region endpoint"},{"url":"https://elasticbeanstalk.{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 Elastic Beanstalk multi-region endpoint"},{"url":"http://elasticbeanstalk.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Elastic Beanstalk endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://elasticbeanstalk.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Elastic Beanstalk endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/#Action=AbortEnvironmentUpdate":{"get":{"x-aws-operation-name":"AbortEnvironmentUpdate","operationId":"GET_AbortEnvironmentUpdate","description":"Cancels in-progress environment configuration update or application version deployment.","responses":{"200":{"description":"Success"},"480":{"description":"InsufficientPrivilegesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientPrivilegesException"}}}}},"parameters":[{"name":"EnvironmentId","in":"query","required":false,"description":"This specifies the ID of the environment with the in-progress update that you want to cancel.","schema":{"type":"string"}},{"name":"EnvironmentName","in":"query","required":false,"description":"This specifies the name of the environment with the in-progress update that you want to cancel.","schema":{"type":"string","minLength":4,"maxLength":40}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AbortEnvironmentUpdate"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]},"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":{"x-aws-operation-name":"AbortEnvironmentUpdate","operationId":"POST_AbortEnvironmentUpdate","description":"Cancels in-progress environment configuration update or application version deployment.","responses":{"200":{"description":"Success"},"480":{"description":"InsufficientPrivilegesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientPrivilegesException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AbortEnvironmentUpdateMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AbortEnvironmentUpdate"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]}},"/#Action=ApplyEnvironmentManagedAction":{"get":{"x-aws-operation-name":"ApplyEnvironmentManagedAction","operationId":"GET_ApplyEnvironmentManagedAction","description":"Applies a scheduled managed action immediately. A managed action can be applied only if its status is <code>Scheduled</code>. Get the status and action ID of a managed action with <a>DescribeEnvironmentManagedActions</a>.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ApplyEnvironmentManagedActionResult"}}}},"480":{"description":"ElasticBeanstalkServiceException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ElasticBeanstalkServiceException"}}}},"481":{"description":"ManagedActionInvalidStateException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ManagedActionInvalidStateException"}}}}},"parameters":[{"name":"EnvironmentName","in":"query","required":false,"description":"The name of the target environment.","schema":{"type":"string"}},{"name":"EnvironmentId","in":"query","required":false,"description":"The environment ID of the target environment.","schema":{"type":"string"}},{"name":"ActionId","in":"query","required":true,"description":"The action ID of the scheduled managed action to execute.","schema":{"type":"string"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ApplyEnvironmentManagedAction"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]},"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":{"x-aws-operation-name":"ApplyEnvironmentManagedAction","operationId":"POST_ApplyEnvironmentManagedAction","description":"Applies a scheduled managed action immediately. A managed action can be applied only if its status is <code>Scheduled</code>. Get the status and action ID of a managed action with <a>DescribeEnvironmentManagedActions</a>.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ApplyEnvironmentManagedActionResult"}}}},"480":{"description":"ElasticBeanstalkServiceException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ElasticBeanstalkServiceException"}}}},"481":{"description":"ManagedActionInvalidStateException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ManagedActionInvalidStateException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ApplyEnvironmentManagedActionRequest"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ApplyEnvironmentManagedAction"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]}},"/#Action=AssociateEnvironmentOperationsRole":{"get":{"x-aws-operation-name":"AssociateEnvironmentOperationsRole","operationId":"GET_AssociateEnvironmentOperationsRole","description":"Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html\">Operations roles</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.","responses":{"200":{"description":"Success"},"480":{"description":"InsufficientPrivilegesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientPrivilegesException"}}}}},"parameters":[{"name":"EnvironmentName","in":"query","required":true,"description":"The name of the environment to which to set the operations role.","schema":{"type":"string","minLength":4,"maxLength":40}},{"name":"OperationsRole","in":"query","required":true,"description":"The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.","schema":{"type":"string","minLength":1,"maxLength":256}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AssociateEnvironmentOperationsRole"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]},"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":{"x-aws-operation-name":"AssociateEnvironmentOperationsRole","operationId":"POST_AssociateEnvironmentOperationsRole","description":"Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html\">Operations roles</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.","responses":{"200":{"description":"Success"},"480":{"description":"InsufficientPrivilegesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientPrivilegesException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AssociateEnvironmentOperationsRoleMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AssociateEnvironmentOperationsRole"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]}},"/#Action=CheckDNSAvailability":{"get":{"x-aws-operation-name":"CheckDNSAvailability","operationId":"GET_CheckDNSAvailability","description":"Checks if the specified CNAME is available.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CheckDNSAvailabilityResultMessage"}}}}},"parameters":[{"name":"CNAMEPrefix","in":"query","required":true,"description":"The prefix used when this CNAME is reserved.","schema":{"type":"string","minLength":4,"maxLength":63}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CheckDNSAvailability"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]},"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":{"x-aws-operation-name":"CheckDNSAvailability","operationId":"POST_CheckDNSAvailability","description":"Checks if the specified CNAME is available.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CheckDNSAvailabilityResultMessage"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CheckDNSAvailabilityMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CheckDNSAvailability"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]}},"/#Action=ComposeEnvironments":{"get":{"x-aws-operation-name":"ComposeEnvironments","operationId":"GET_ComposeEnvironments","description":"Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named <code>env.yaml</code>. See <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html\">Compose Environments</a> for details.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/EnvironmentDescriptionsMessage"}}}},"480":{"description":"TooManyEnvironmentsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyEnvironmentsException"}}}},"481":{"description":"InsufficientPrivilegesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientPrivilegesException"}}}}},"parameters":[{"name":"ApplicationName","in":"query","required":false,"description":"The name of the application to which the specified source bundles belong.","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"GroupName","in":"query","required":false,"description":"The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html\">Environment Manifest (env.yaml)</a> for details.","schema":{"type":"string","minLength":1,"maxLength":19}},{"name":"VersionLabels","in":"query","required":false,"description":"A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.","schema":{"type":"array","items":{"$ref":"#/components/schemas/VersionLabel"}}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ComposeEnvironments"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]},"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":{"x-aws-operation-name":"ComposeEnvironments","operationId":"POST_ComposeEnvironments","description":"Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named <code>env.yaml</code>. See <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html\">Compose Environments</a> for details.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/EnvironmentDescriptionsMessage"}}}},"480":{"description":"TooManyEnvironmentsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyEnvironmentsException"}}}},"481":{"description":"InsufficientPrivilegesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientPrivilegesException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ComposeEnvironmentsMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ComposeEnvironments"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]}},"/#Action=CreateApplication":{"get":{"x-aws-operation-name":"CreateApplication","operationId":"GET_CreateApplication","description":"Creates an application that has one configuration template named <code>default</code> and no application versions.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ApplicationDescriptionMessage"}}}},"480":{"description":"TooManyApplicationsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyApplicationsException"}}}}},"parameters":[{"name":"ApplicationName","in":"query","required":true,"description":"The name of the application. Must be unique within your account.","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"Description","in":"query","required":false,"description":"Your description of the application.","schema":{"type":"string","maxLength":200}},{"name":"ResourceLifecycleConfig","in":"query","required":false,"description":"Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.","schema":{"type":"object","properties":{"ServiceRole":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"<p>The ARN of an IAM service role that Elastic Beanstalk has permission to assume.</p> <p>The <code>ServiceRole</code> property is required the first time that you provide a <code>VersionLifecycleConfig</code> for the application in one of the supporting calls (<code>CreateApplication</code> or <code>UpdateApplicationResourceLifecycle</code>). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent <code>UpdateApplicationResourceLifecycle</code> calls. You can, however, specify it in subsequent calls to change the Service Role to another value.</p>"}]},"VersionLifecycleConfig":{"allOf":[{"$ref":"#/components/schemas/ApplicationVersionLifecycleConfig"},{"description":"Defines lifecycle settings for application versions."}]}},"description":"The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that AWS Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions."}},{"name":"Tags","in":"query","required":false,"description":"<p>Specifies the tags applied to the application.</p> <p>Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don't inherit the tags.</p>","schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CreateApplication"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]},"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":{"x-aws-operation-name":"CreateApplication","operationId":"POST_CreateApplication","description":"Creates an application that has one configuration template named <code>default</code> and no application versions.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ApplicationDescriptionMessage"}}}},"480":{"description":"TooManyApplicationsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyApplicationsException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CreateApplicationMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CreateApplication"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]}},"/#Action=CreateApplicationVersion":{"get":{"x-aws-operation-name":"CreateApplicationVersion","operationId":"GET_CreateApplicationVersion","description":"<p>Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:</p> <p>Specify a commit in an AWS CodeCommit repository with <code>SourceBuildInformation</code>.</p> <p>Specify a build in an AWS CodeBuild with <code>SourceBuildInformation</code> and <code>BuildConfiguration</code>.</p> <p>Specify a source bundle in S3 with <code>SourceBundle</code> </p> <p>Omit both <code>SourceBuildInformation</code> and <code>SourceBundle</code> to use the default sample application.</p> <note> <p>After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.</p> </note>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ApplicationVersionDescriptionMessage"}}}},"480":{"description":"TooManyApplicationsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyApplicationsException"}}}},"481":{"description":"TooManyApplicationVersionsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyApplicationVersionsException"}}}},"482":{"description":"InsufficientPrivilegesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientPrivilegesException"}}}},"483":{"description":"S3LocationNotInServiceRegionException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/S3LocationNotInServiceRegionException"}}}},"484":{"description":"CodeBuildNotInServiceRegionException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CodeBuildNotInServiceRegionException"}}}}},"parameters":[{"name":"ApplicationName","in":"query","required":true,"description":" The name of the application. If no application is found with this name, and <code>AutoCreateApplication</code> is <code>false</code>, returns an <code>InvalidParameterValue</code> error. ","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"VersionLabel","in":"query","required":true,"description":"<p>A label identifying this version.</p> <p>Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p>","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"Description","in":"query","required":false,"description":"A description of this application version.","schema":{"type":"string","maxLength":200}},{"name":"SourceBuildInformation","in":"query","required":false,"description":"Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.","schema":{"type":"object","required":["SourceType","SourceRepository","SourceLocation"],"properties":{"SourceType":{"allOf":[{"$ref":"#/components/schemas/SourceType"},{"description":"<p>The type of repository.</p> <ul> <li> <p> <code>Git</code> </p> </li> <li> <p> <code>Zip</code> </p> </li> </ul>"}]},"SourceRepository":{"allOf":[{"$ref":"#/components/schemas/SourceRepository"},{"description":"<p>Location where the repository is stored.</p> <ul> <li> <p> <code>CodeCommit</code> </p> </li> <li> <p> <code>S3</code> </p> </li> </ul>"}]},"SourceLocation":{"allOf":[{"$ref":"#/components/schemas/SourceLocation"},{"description":"<p>The location of the source code, as a formatted string, depending on the value of <code>SourceRepository</code> </p> <ul> <li> <p>For <code>CodeCommit</code>, the format is the repository name and commit ID, separated by a forward slash. For example, <code>my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a</code>.</p> </li> <li> <p>For <code>S3</code>, the format is the S3 bucket name and object key, separated by a forward slash. For example, <code>my-s3-bucket/Folders/my-source-file</code>.</p> </li> </ul>"}]}},"description":"Location of the source code for an application version."}},{"name":"SourceBundle","in":"query","required":false,"description":"<p>The Amazon S3 bucket and key that identify the location of the source bundle for this version.</p> <note> <p>The Amazon S3 bucket must be in the same region as the environment.</p> </note> <p>Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with <code>SourceBuildInformation</code>), but not both. If neither <code>SourceBundle</code> nor <code>SourceBuildInformation</code> are provided, Elastic Beanstalk uses a sample application.</p>","schema":{"type":"object","properties":{"S3Bucket":{"allOf":[{"$ref":"#/components/schemas/S3Bucket"},{"description":"The Amazon S3 bucket where the data is located."}]},"S3Key":{"allOf":[{"$ref":"#/components/schemas/S3Key"},{"description":"The Amazon S3 key where the data is located."}]}},"description":"The bucket and key of an item stored in Amazon S3."}},{"name":"BuildConfiguration","in":"query","required":false,"description":"Settings for an AWS CodeBuild build.","schema":{"type":"object","required":["CodeBuildServiceRole","Image"],"properties":{"ArtifactName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location <i>S3-bucket</i>/resources/<i>application-name</i>/codebuild/codebuild-<i>version-label</i>-<i>artifact-name</i>.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location <i>S3-bucket</i>/resources/<i>application-name</i>/codebuild/codebuild-<i>version-label</i>.zip. "}]},"CodeBuildServiceRole":{"allOf":[{"$ref":"#/components/schemas/NonEmptyString"},{"description":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account."}]},"ComputeType":{"allOf":[{"$ref":"#/components/schemas/ComputeType"},{"description":"<p>Information about the compute resources the build project will use.</p> <ul> <li> <p> <code>BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds</code> </p> </li> <li> <p> <code>BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds</code> </p> </li> <li> <p> <code>BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds</code> </p> </li> </ul>"}]},"Image":{"allOf":[{"$ref":"#/components/schemas/NonEmptyString"},{"description":"The ID of the Docker image to use for this build project."}]},"TimeoutInMinutes":{"allOf":[{"$ref":"#/components/schemas/BoxedInt"},{"description":"How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes."}]}},"description":"Settings for an AWS CodeBuild build."}},{"name":"AutoCreateApplication","in":"query","required":false,"description":"Set to <code>true</code> to create an application with the specified name if it doesn't already exist.","schema":{"type":"boolean"}},{"name":"Process","in":"query","required":false,"description":"<p>Pre-processes and validates the environment manifest (<code>env.yaml</code>) and configuration files (<code>*.config</code> files in the <code>.ebextensions</code> folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.</p> <p>You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.</p> <note> <p>The <code>Process</code> option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.</p> </note>","schema":{"type":"boolean"}},{"name":"Tags","in":"query","required":false,"description":"<p>Specifies the tags applied to the application version.</p> <p>Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags.</p>","schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CreateApplicationVersion"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]},"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":{"x-aws-operation-name":"CreateApplicationVersion","operationId":"POST_CreateApplicationVersion","description":"<p>Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:</p> <p>Specify a commit in an AWS CodeCommit repository with <code>SourceBuildInformation</code>.</p> <p>Specify a build in an AWS CodeBuild with <code>SourceBuildInformation</code> and <code>BuildConfiguration</code>.</p> <p>Specify a source bundle in S3 with <code>SourceBundle</code> </p> <p>Omit both <code>SourceBuildInformation</code> and <code>SourceBundle</code> to use the default sample application.</p> <note> <p>After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.</p> </note>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ApplicationVersionDescriptionMessage"}}}},"480":{"description":"TooManyApplicationsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyApplicationsException"}}}},"481":{"description":"TooManyApplicationVersionsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyApplicationVersionsException"}}}},"482":{"description":"InsufficientPrivilegesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientPrivilegesException"}}}},"483":{"description":"S3LocationNotInServiceRegionException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/S3LocationNotInServiceRegionException"}}}},"484":{"description":"CodeBuildNotInServiceRegionException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CodeBuildNotInServiceRegionException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CreateApplicationVersionMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CreateApplicationVersion"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]}},"/#Action=CreateConfigurationTemplate":{"get":{"x-aws-operation-name":"CreateConfigurationTemplate","operationId":"GET_CreateConfigurationTemplate","description":"<p>Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.</p> <p>Templates aren't associated with any environment. The <code>EnvironmentName</code> response element is always <code>null</code>.</p> <p>Related Topics</p> <ul> <li> <p> <a>DescribeConfigurationOptions</a> </p> </li> <li> <p> <a>DescribeConfigurationSettings</a> </p> </li> <li> <p> <a>ListAvailableSolutionStacks</a> </p> </li> </ul>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ConfigurationSettingsDescription"}}}},"480":{"description":"InsufficientPrivilegesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientPrivilegesException"}}}},"481":{"description":"TooManyBucketsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyBucketsException"}}}},"482":{"description":"TooManyConfigurationTemplatesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyConfigurationTemplatesException"}}}}},"parameters":[{"name":"ApplicationName","in":"query","required":true,"description":"The name of the Elastic Beanstalk application to associate with this configuration template.","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"TemplateName","in":"query","required":true,"description":"<p>The name of the configuration template.</p> <p>Constraint: This name must be unique per application.</p>","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"SolutionStackName","in":"query","required":false,"description":"<p>The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, <code>64bit Amazon Linux 2013.09 running Tomcat 7 Java 7</code>. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html\">Supported Platforms</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.</p> <p>You must specify <code>SolutionStackName</code> if you don't specify <code>PlatformArn</code>, <code>EnvironmentId</code>, or <code>SourceConfiguration</code>.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html\"> <code>ListAvailableSolutionStacks</code> </a> API to obtain a list of available solution stacks.</p>","schema":{"type":"string"}},{"name":"PlatformArn","in":"query","required":false,"description":"<p>The Amazon Resource Name (ARN) of the custom platform. For more information, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html\"> Custom Platforms</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.</p> <note> <p>If you specify <code>PlatformArn</code>, then don't specify <code>SolutionStackName</code>.</p> </note>","schema":{"type":"string"}},{"name":"SourceConfiguration","in":"query","required":false,"description":"<p>An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.</p> <p>Values specified in <code>OptionSettings</code> override any values obtained from the <code>SourceConfiguration</code>.</p> <p>You must specify <code>SourceConfiguration</code> if you don't specify <code>PlatformArn</code>, <code>EnvironmentId</code>, or <code>SolutionStackName</code>.</p> <p>Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.</p>","schema":{"type":"object","properties":{"ApplicationName":{"allOf":[{"$ref":"#/components/schemas/ApplicationName"},{"description":"The name of the application associated with the configuration."}]},"TemplateName":{"allOf":[{"$ref":"#/components/schemas/ConfigurationTemplateName"},{"description":"The name of the configuration template."}]}},"description":"A specification for an environment configuration."}},{"name":"EnvironmentId","in":"query","required":false,"description":"The ID of an environment whose settings you want to use to create the configuration template. You must specify <code>EnvironmentId</code> if you don't specify <code>PlatformArn</code>, <code>SolutionStackName</code>, or <code>SourceConfiguration</code>.","schema":{"type":"string"}},{"name":"Description","in":"query","required":false,"description":"An optional description for this configuration.","schema":{"type":"string","maxLength":200}},{"name":"OptionSettings","in":"query","required":false,"description":"Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html\">Option Values</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.","schema":{"type":"array","items":{"$ref":"#/components/schemas/ConfigurationOptionSetting"}}},{"name":"Tags","in":"query","required":false,"description":"Specifies the tags applied to the configuration template.","schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CreateConfigurationTemplate"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]},"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":{"x-aws-operation-name":"CreateConfigurationTemplate","operationId":"POST_CreateConfigurationTemplate","description":"<p>Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.</p> <p>Templates aren't associated with any environment. The <code>EnvironmentName</code> response element is always <code>null</code>.</p> <p>Related Topics</p> <ul> <li> <p> <a>DescribeConfigurationOptions</a> </p> </li> <li> <p> <a>DescribeConfigurationSettings</a> </p> </li> <li> <p> <a>ListAvailableSolutionStacks</a> </p> </li> </ul>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ConfigurationSettingsDescription"}}}},"480":{"description":"InsufficientPrivilegesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientPrivilegesException"}}}},"481":{"description":"TooManyBucketsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyBucketsException"}}}},"482":{"description":"TooManyConfigurationTemplatesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyConfigurationTemplatesException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CreateConfigurationTemplateMessage"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CreateConfigurationTemplate"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]}},"/#Action=CreateEnvironment":{"get":{"x-aws-operation-name":"CreateEnvironment","operationId":"GET_CreateEnvironment","description":"Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/EnvironmentDescription"}}}},"480":{"description":"TooManyEnvironmentsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyEnvironmentsException"}}}},"481":{"description":"InsufficientPrivilegesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientPrivilegesException"}}}}},"parameters":[{"name":"ApplicationName","in":"query","required":true,"description":"The name of the application that is associated with this environment.","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"EnvironmentName","in":"query","required":false,"description":"<p>A unique name for the environment.</p> <p>Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p> <p>If you don't specify the <code>CNAMEPrefix</code> parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.</p>","schema":{"type":"string","minLength":4,"maxLength":40}},{"name":"GroupName","in":"query","required":false,"description":"The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html\">Environment Manifest (env.yaml)</a> for details.","schema":{"type":"string","minLength":1,"maxLength":19}},{"name":"Description","in":"query","required":false,"description":"Your description for this environment.","schema":{"type":"string","maxLength":200}},{"name":"CNAMEPrefix","in":"query","required":false,"description":"If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.","schema":{"type":"string","minLength":4,"maxLength":63}},{"name":"Tier","in":"query","required":false,"description":"Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.","schema":{"type":"object","properties":{"Name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"<p>The name of this environment tier.</p> <p>Valid values:</p> <ul> <li> <p>For <i>Web server tier</i> – <code>WebServer</code> </p> </li> <li> <p>For <i>Worker tier</i> – <code>Worker</code> </p> </li> </ul>"}]},"Type":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"<p>The type of this environment tier.</p> <p>Valid values:</p> <ul> <li> <p>For <i>Web server tier</i> – <code>Standard</code> </p> </li> <li> <p>For <i>Worker tier</i> – <code>SQS/HTTP</code> </p> </li> </ul>"}]},"Version":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"<p>The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.</p> <note> <p>This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.</p> </note>"}]}},"description":"Describes the properties of an environment tier"}},{"name":"Tags","in":"query","required":false,"description":"Specifies the tags applied to resources in the environment.","schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},{"name":"VersionLabel","in":"query","required":false,"description":"<p>The name of the application version to deploy.</p> <p>Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.</p>","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"TemplateName","in":"query","required":false,"description":"<p>The name of the Elastic Beanstalk configuration template to use with the environment.</p> <note> <p>If you specify <code>TemplateName</code>, then don't specify <code>SolutionStackName</code>.</p> </note>","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"SolutionStackName","in":"query","required":false,"description":"<p>The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html\">Elastic Beanstalk Supported Platforms</a> in the <i>AWS Elastic Beanstalk Platforms</i> guide.</p> <note> <p>If you specify <code>SolutionStackName</code>, don't specify <code>PlatformArn</code> or <code>TemplateName</code>.</p> </note>","schema":{"type":"string"}},{"name":"PlatformArn","in":"query","required":false,"description":"<p>The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html\">Custom Platforms</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.</p> <note> <p>If you specify <code>PlatformArn</code>, don't specify <code>SolutionStackName</code>.</p> </note>","schema":{"type":"string"}},{"name":"OptionSettings","in":"query","required":false,"description":"If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.","schema":{"type":"array","items":{"$ref":"#/components/schemas/ConfigurationOptionSetting"}}},{"name":"OptionsToRemove","in":"query","required":false,"description":"A list of custom user-defined configuration options to remove from the configuration set for this new environment.","schema":{"type":"array","items":{"$ref":"#/components/schemas/OptionSpecification"}}},{"name":"OperationsRole","in":"query","required":false,"description":"The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the <code>iam:PassRole</code> permission for the role. For more information, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html\">Operations roles</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.","schema":{"type":"string","minLength":1,"maxLength":256}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CreateEnvironment"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-12-01"]}}]},"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":{"x-aws-operation-name":"CreateEnvironment","operationId":"POST_CreateEnvironment","description":"Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.","responses":{"200":{"description