ComposeEnvironments
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 env.yaml. See Compose Environments for details.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ApplicationName
-
The name of the application to which the specified source bundles belong.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- GroupName
-
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 Environment Manifest (env.yaml) for details.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 19.
Required: No
- VersionLabels.member.N
-
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.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
Response Elements
The following elements are returned by the service.
- Environments.member.N
-
Returns an EnvironmentDescription list.
Type: Array of EnvironmentDescription objects
- NextToken
-
In a paginated request, the token that you can pass in a subsequent request to get the next response page.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InsufficientPrivileges
-
The specified account does not have sufficient privileges for one or more AWS services.
HTTP Status Code: 403
- TooManyEnvironments
-
The specified account has reached its limit of environments.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
