OpsWorks / Client / describe_agent_versions

describe_agent_versions#

OpsWorks.Client.describe_agent_versions(**kwargs)#

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

response = client.describe_agent_versions(
    StackId='string',
    ConfigurationManager={
        'Name': 'string',
        'Version': 'string'
    }
)

Parameters:

StackId (string) – The stack ID.
ConfigurationManager (dict) –
The configuration manager.
- Name (string) –
  
  The name. This parameter must be set to “Chef”.
- Version (string) –
  
  The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.

Return type:

dict

Returns:

Response Syntax

{
    'AgentVersions': [
        {
            'Version': 'string',
            'ConfigurationManager': {
                'Name': 'string',
                'Version': 'string'
            }
        },
    ]
}

Response Structure

(dict) –

Contains the response to a DescribeAgentVersions request.
- AgentVersions (list) –
  
  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.
  - (dict) –
    
    Describes an agent version.
    - Version (string) –
      
      The agent version.
    - ConfigurationManager (dict) –
      
      The configuration manager.
      - Name (string) –
        
        The name. This parameter must be set to “Chef”.
      - Version (string) –
        
        The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.

Exceptions

OpsWorks.Client.exceptions.ValidationException
OpsWorks.Client.exceptions.ResourceNotFoundException