GetConfigurationProfile - AWS AppConfig

GetConfigurationProfile

Retrieve information about a configuration profile.

Request Syntax

GET /applications/ApplicationId/configurationprofiles/ConfigurationProfileId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ApplicationId

The ID of the application that includes the configuration profile you want to get.

Pattern: [a-z0-9]{4,7}

Required: Yes

ConfigurationProfileId

The ID of the configuration profile you want to get.

Pattern: [a-z0-9]{4,7}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ApplicationId": "string", "Description": "string", "Id": "string", "LocationUri": "string", "Name": "string", "RetrievalRoleArn": "string", "Validators": [ { "Content": "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.

ApplicationId

The application ID.

Type: String

Pattern: [a-z0-9]{4,7}

Description

The configuration profile description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Id

The configuration profile ID.

Type: String

Pattern: [a-z0-9]{4,7}

LocationUri

The URI location of the configuration.

Type: String

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

Name

The name of the configuration profile.

Type: String

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

RetrievalRoleArn

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\d{12}:role[/].*)$

Validators

A list of methods for validating the configuration.

Type: Array of Validator objects

Array Members: Minimum number of 0 items. Maximum number of 2 items.

Errors

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

BadRequestException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

InternalServerException

There was an internal failure in the AppConfig service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

See Also

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