Menu
AWS OpsWorks
API Reference (API Version 2013-02-18)

DescribeAgentVersions

Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager.

Request Syntax

{
   "ConfigurationManager": { 
      "Name": "string",
      "Version": "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.

ConfigurationManager

The configuration manager.

Type: StackConfigurationManager object

Required: No

StackId

The stack ID.

Type: String

Required: No

Response Syntax

{
   "AgentVersions": [ 
      { 
         "ConfigurationManager": { 
            "Name": "string",
            "Version": "string"
         },
         "Version": "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.

AgentVersions

The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console.

Type: Array of AgentVersion 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

See Also

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