Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeApps

Requests a description of a specified set of apps.

Note

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Request Syntax


{
   "AppIds": [ "string" ],
   "StackId": "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.

AppIds

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

Type: Array of strings

Required: No

StackId

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

Type: String

Required: No

Response Syntax


{
   "Apps": [ 
      { 
         "AppId": "string",
         "AppSource": { 
            "Password": "string",
            "Revision": "string",
            "SshKey": "string",
            "Type": "string",
            "Url": "string",
            "Username": "string"
         },
         "Attributes": { 
            "string" : "string" 
         },
         "CreatedAt": "string",
         "DataSources": [ 
            { 
               "Arn": "string",
               "DatabaseName": "string",
               "Type": "string"
            }
         ],
         "Description": "string",
         "Domains": [ "string" ],
         "EnableSsl": boolean,
         "Environment": [ 
            { 
               "Key": "string",
               "Secure": boolean,
               "Value": "string"
            }
         ],
         "Name": "string",
         "Shortname": "string",
         "SslConfiguration": { 
            "Certificate": "string",
            "Chain": "string",
            "PrivateKey": "string"
         },
         "StackId": "string",
         "Type": "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.

Apps

An array of App objects that describe the specified apps.

Type: Array of App objects

Errors

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

ResourceNotFoundException

Indicates that a resource was not found.

HTTP Status Code: 400

ValidationException

Indicates that a request was not valid.

HTTP Status Code: 400