DescribeApplications - AWS Elastic Beanstalk

DescribeApplications

Returns the descriptions of existing applications.

This action only returns information about applications that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access two of three applications. When the user calls the DescribeApplications action, the response will only include the two applications that the user has permission to access instead of all three applications. If the user doesn’t have access to any of the applications an empty result is returned.

Note

The AWSElasticBeanstalkReadOnly managed policy allows operators to view information about resources related to Elastic Beanstalk environments. For more information, see Managing Elastic Beanstalk user policies in the AWS Elastic Beanstalk Developer Guide. For detailed instructions to attach a policy to a user or group, see the section Controlling access with managed policies in the same topic.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ApplicationNames.member.N

If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

Response Elements

The following element is returned by the service.

Applications.member.N

This parameter contains a list of ApplicationDescription.

Type: Array of ApplicationDescription objects

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

This example illustrates one usage of DescribeApplications.

Sample Request

https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationNames.member.1=SampleApplication &Operation=DescribeApplications &AuthParams

Sample Response

<DescribeApplicationsResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/"> <DescribeApplicationsResult> <Applications> <member> <Versions/> <Description>Sample Description</Description> <ApplicationName>SampleApplication</ApplicationName> <DateCreated>2010-11-16T20:20:51.974Z</DateCreated> <DateUpdated>2010-11-16T20:20:51.974Z</DateUpdated> <ConfigurationTemplates> <member>Default</member> </ConfigurationTemplates> </member> </Applications> </DescribeApplicationsResult> <ResponseMetadata> <RequestId>577c70ff-f1d7-11df-8a78-9f77047e0d0c</RequestId> </ResponseMetadata> </DescribeApplicationsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: