Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetConfigurationManager

Returns a configuration manager.

Request Syntax


GET /configurationManager/ManagerArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ManagerArn

The ARN of the configuration manager.

Length Constraints: Minimum length of 1.

Pattern: ^arn:aws:ssm-quicksetup:([^:]+):(\d{12}):configuration-manager/[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConfigurationDefinitions": [ 
      { 
         "Id": "string",
         "LocalDeploymentAdministrationRoleArn": "string",
         "LocalDeploymentExecutionRoleName": "string",
         "Parameters": { 
            "string" : "string" 
         },
         "Type": "string",
         "TypeVersion": "string"
      }
   ],
   "CreatedAt": "string",
   "Description": "string",
   "LastModifiedAt": "string",
   "ManagerArn": "string",
   "Name": "string",
   "StatusSummaries": [ 
      { 
         "LastUpdatedAt": "string",
         "Status": "string",
         "StatusDetails": { 
            "string" : "string" 
         },
         "StatusMessage": "string",
         "StatusType": "string"
      }
   ],
   "Tags": { 
      "string" : "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.

ConfigurationDefinitions

The configuration definitions association with the configuration manager.

Type: Array of ConfigurationDefinition objects

CreatedAt

The datetime stamp when the configuration manager was created.

Type: Timestamp

Description

The description of the configuration manager.

Type: String

LastModifiedAt

The datetime stamp when the configuration manager was last updated.

Type: Timestamp

ManagerArn

The ARN of the configuration manager.

Type: String

Name

The name of the configuration manager.

Type: String

StatusSummaries

A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.

Type: Array of StatusSummary objects

Tags

Key-value pairs of metadata to assign to the configuration manager.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^[A-Za-z0-9 _=@:.+-/]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^[A-Za-z0-9 _=@:.+-/]+$

Errors

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

AccessDeniedException

The requester has insufficient permissions to perform the operation.

HTTP Status Code: 403

ConflictException

Another request is being processed. Wait a few minutes and try again.

HTTP Status Code: 409

InternalServerException

An error occurred on the server side.

HTTP Status Code: 500

ResourceNotFoundException

The resource couldn't be found. Check the ID or name and try again.

HTTP Status Code: 404

ThrottlingException

The request or operation exceeds the maximum allowed request rate per AWS account and AWS Region.

HTTP Status Code: 429

ValidationException

The request is invalid. Verify the values provided for the request parameters are accurate.

HTTP Status Code: 400