DescribeApplications
Retrieves a list that describes one or more applications.
Request Syntax
{
"Arns": [ "string" ],
"MaxResults": number,
"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.
- Arns
-
The ARNs for the applications.
Type: Array of strings
Pattern:
^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$Required: No
- MaxResults
-
The maximum size of each page of results.
Type: Integer
Required: No
- NextToken
-
The pagination token used to retrieve the next page of results for this operation.
Type: String
Length Constraints: Minimum length of 1.
Required: No
Response Syntax
{
"Applications": [
{
"AppBlockArn": "string",
"Arn": "string",
"CreatedTime": number,
"Description": "string",
"DisplayName": "string",
"Enabled": boolean,
"IconS3Location": {
"S3Bucket": "string",
"S3Key": "string"
},
"IconURL": "string",
"InstanceFamilies": [ "string" ],
"LaunchParameters": "string",
"LaunchPath": "string",
"Metadata": {
"string" : "string"
},
"Name": "string",
"Platforms": [ "string" ],
"WorkingDirectory": "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.
- Applications
-
The applications in the list.
Type: Array of Application objects
- NextToken
-
The pagination token used to retrieve the next page of results for this operation.
Type: String
Length Constraints: Minimum length of 1.
Errors
For information about the errors that are common to all actions, see Common Errors.
- OperationNotPermittedException
-
The attempted operation is not permitted.
- Message
-
The error message in the exception.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
- Message
-
The error message in the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
