ListDeploymentGroups
Lists the deployment groups for an application registered with the AWS user or AWS account.
Request Syntax
{
"applicationName": "string",
"nextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- applicationName
-
The name of an AWS CodeDeploy application associated with the user or AWS account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- nextToken
-
An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.
Type: String
Required: No
Response Syntax
{
"applicationName": "string",
"deploymentGroups": [ "string" ],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- applicationName
-
The application name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
- deploymentGroups
-
A list of deployment group names.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 100.
- nextToken
-
If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- ApplicationDoesNotExistException
-
The application does not exist with the user or AWS account.
HTTP Status Code: 400
- ApplicationNameRequiredException
-
The minimum number of required application names was not specified.
HTTP Status Code: 400
- InvalidApplicationNameException
-
The application name was specified in an invalid format.
HTTP Status Code: 400
- InvalidNextTokenException
-
The next token was specified in an invalid format.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ListDeploymentGroups.
Sample Request
POST / HTTP/1.1
Host: codedeploy.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 45
X-Amz-Target: CodeDeploy_20141006.ListDeploymentGroups
X-Amz-Date: 20160707T021406Z
User-Agent: aws-cli/1.10.6 Python/2.7.9 Windows/7 botocore/1.3.28
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20160707/us-east-1/codedeploy/aws4_request,
SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
{
"applicationName": "TestApp-us-east-1"
}Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 0f5599cb-88e3-11e5-a087-ab26ee53e16e
Content-Type: application/x-amz-json-1.1
Content-Length: 95
{
"applicationName": "TestApp-us-east-1",
"deploymentGroups": [
"dep-group-def-456"
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
