GetConﬁgurationProﬁle

Service: AWS AppConﬁg

Retrieves information about a conﬁguration proﬁle.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

ApplicationId (p. 44)

The ID of the application that includes the conﬁguration proﬁle you want to get.

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

Required: Yes

ConﬁgurationProﬁleId (p. 44)

The ID of the conﬁguration proﬁle that 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", "Type": "string",

"Validators": [ {

"Content": "string", "Type": "string"

} ]}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

GetConﬁgurationProﬁle

The following data is returned in JSON format by the service.

ApplicationId (p. 44) The application ID.

Type: String

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

Description (p. 44)

The conﬁguration proﬁle description.

Type: String

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

Id (p. 44)

The conﬁguration proﬁle ID.

Type: String

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

LocationUri (p. 44)

The URI location of the conﬁguration.

Type: String

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

Name (p. 44)

The name of the conﬁguration proﬁle.

Type: String

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

RetrievalRoleArn (p. 44)

The ARN of an IAM role with permission to access the conﬁguration at the speciﬁed 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[/].*)$

Type (p. 44)

The type of conﬁgurations contained in the proﬁle. AWS AppConﬁg supports feature flags and freeform conﬁgurations. We recommend you create feature ﬂag conﬁgurations to enable or disable new features and freeform conﬁgurations to distribute conﬁgurations to an application.

When calling this API, enter one of the following values for Type:

AWS.AppConfig.FeatureFlags AWS.Freeform

Type: String

GetConﬁgurationProﬁle

Pattern: ^[a-zA-Z\.]+

Validators (p. 44)

A list of methods for validating the conﬁguration.

Type: Array of Validator (p. 145) 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 (p. 150).

BadRequestException

The input fails to satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400 InternalServerException

There was an internal failure in the AWS AppConﬁg service.

HTTP Status Code: 500 ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

Examples

Example

This example illustrates one usage of GetConﬁgurationProﬁle.

Sample Request

GET /applications/abc1234/configurationprofiles/ur8hx2f HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com

Accept-Encoding: identity

User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/

x86_64.amzn.2 prompt/off command/appconfig.get-configuration-profile X-Amz-Date: 20210917T221417Z

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/

appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE

Sample Response

{ "ApplicationId": "abc1234", "Id": "ur8hx2f",

"Name": "Example-Configuration-Profile",

"LocationUri": "ssm-parameter://Example-Parameter",

"RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role"

}

GetConﬁgurationProﬁle

Request Syntax

GET /applications/ApplicationId/environments/EnvironmentId/deployments/DeploymentNumber HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ApplicationId (p. 48)

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

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

Required: Yes

DeploymentNumber (p. 48)

The sequence number of the deployment.

Required: Yes EnvironmentId (p. 48)

The ID of the environment that includes the deployment 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", "CompletedAt": number,

"ConfigurationLocationUri": "string", "ConfigurationName": "string", "ConfigurationProfileId": "string", "ConfigurationVersion": "string", "DeploymentDurationInMinutes": number, "DeploymentNumber": number,

"DeploymentStrategyId": "string", "Description": "string",

"EnvironmentId": "string", "EventLog": [

{

"Description": "string",

GetDeployment

"FinalBakeTimeInMinutes": number, "GrowthFactor": number,

"GrowthType": "string", "PercentageComplete": number, "StartedAt": number,

"State": "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 (p. 48)

The ID of the application that was deployed.

Type: String

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

CompletedAt (p. 48)

The time the deployment completed.

Type: Timestamp

ConﬁgurationLocationUri (p. 48)

Information about the source location of the conﬁguration.

Type: String

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

ConﬁgurationName (p. 48) The name of the conﬁguration.

Type: String

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

ConﬁgurationProﬁleId (p. 48)

The ID of the conﬁguration proﬁle that was deployed.

Type: String

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

ConﬁgurationVersion (p. 48)

The conﬁguration version that was deployed.

Type: String

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

DeploymentDurationInMinutes (p. 48)

Total amount of time the deployment lasted.

GetDeployment

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1440.

DeploymentNumber (p. 48)

The sequence number of the deployment.

Type: Integer

DeploymentStrategyId (p. 48)

The ID of the deployment strategy that was deployed.

Type: String

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

Description (p. 48)

The description of the deployment.

Type: String

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

EnvironmentId (p. 48)

The ID of the environment that was deployed.

Type: String

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

EventLog (p. 48)

A list containing all events related to a deployment. The most recent events are displayed ﬁrst.

Type: Array of DeploymentEvent (p. 133) objects FinalBakeTimeInMinutes (p. 48)

The amount of time that AWS AppConﬁg monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1440.

GrowthFactor (p. 48)

The percentage of targets to receive a deployed conﬁguration during each interval.

Type: Float

Valid Range: Minimum value of 1.0. Maximum value of 100.0.

GrowthType (p. 48)

The algorithm used to deﬁne how percentage grew over time.

Type: String

Valid Values: LINEAR | EXPONENTIAL PercentageComplete (p. 48)

The percentage of targets for which the deployment is available.

Type: Float

GetDeployment

Valid Range: Minimum value of 1.0. Maximum value of 100.0.

StartedAt (p. 48)

The time the deployment started.

Type: Timestamp State (p. 48)

The state of the deployment.

Type: String

Errors

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

BadRequestException

The input fails to satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400 InternalServerException

There was an internal failure in the AWS AppConﬁg service.

HTTP Status Code: 500 ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

Examples

Example

This example illustrates one usage of GetDeployment.

Sample Request

GET /applications/abc1234/environments/54j1r29/deployments/1 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com

Accept-Encoding: identity

User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/

x86_64.amzn.2 prompt/off command/appconfig.get-deployment X-Amz-Date: 20210917T222704Z

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/

appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE

Sample Response

{ "ApplicationId": "abc1234", "EnvironmentId": "54j1r29", "DeploymentStrategyId": "1225qzk",

GetDeployment

"ConfigurationProfileId": "ur8hx2f", "DeploymentNumber": 1,

"ConfigurationName": "Example-Configuration-Profile",

"ConfigurationLocationUri": "ssm-parameter://Example-Parameter", "ConfigurationVersion": "1",

"DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR",

"GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "State": "COMPLETE",

"EventLog": [ {

"EventType": "DEPLOYMENT_COMPLETED", "TriggeredBy": "APPCONFIG",

"Description": "Deployment completed",

"OccurredAt": "2021-09-17T21:59:03.888000+00:00"

}, {

"EventType": "BAKE_TIME_STARTED", "TriggeredBy": "APPCONFIG",

"Description": "Deployment bake time started", "OccurredAt": "2021-09-17T21:58:57.722000+00:00"

}, {

"EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG",

"Description": "Configuration available to 100.00% of clients", "OccurredAt": "2021-09-17T21:55:56.816000+00:00"

}, {

"EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG",

"Description": "Configuration available to 75.00% of clients", "OccurredAt": "2021-09-17T21:52:56.567000+00:00"

}, {

"EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG",

"Description": "Configuration available to 50.00% of clients", "OccurredAt": "2021-09-17T21:49:55.737000+00:00"

}, {

"EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG",

"Description": "Configuration available to 25.00% of clients", "OccurredAt": "2021-09-17T21:46:55.187000+00:00"

}, {

"EventType": "DEPLOYMENT_STARTED", "TriggeredBy": "USER",

"Description": "Deployment started",

"OccurredAt": "2021-09-17T21:43:54.205000+00:00"

} ],

"PercentageComplete": 100.0,

"StartedAt": "2021-09-17T21:43:54.205000+00:00", "CompletedAt": "2021-09-17T21:59:03.888000+00:00"

}

Request Syntax

GET /deploymentstrategies/DeploymentStrategyId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DeploymentStrategyId (p. 54)

The ID of the deployment strategy to get.

Pattern: (^[a-z0-9]{4,7}$|^AppConfig\.[A-Za-z0-9]{9,40}$) Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json

{ "DeploymentDurationInMinutes": number, "Description": "string",

"FinalBakeTimeInMinutes": number, "GrowthFactor": number,

"GrowthType": "string", "Id": "string",

"Name": "string", "ReplicateTo": "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.

DeploymentDurationInMinutes (p. 54)

Total amount of time the deployment lasted.

Type: Integer

GetDeploymentStrategy

Valid Range: Minimum value of 0. Maximum value of 1440.

Description (p. 54)

The description of the deployment strategy.

Type: String

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

FinalBakeTimeInMinutes (p. 54)

The amount of time that AWS AppConﬁg monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1440.

GrowthFactor (p. 54)

The percentage of targets that received a deployed conﬁguration during each interval.

Type: Float

Valid Range: Minimum value of 1.0. Maximum value of 100.0.

GrowthType (p. 54)

The algorithm used to deﬁne how percentage grew over time.

Type: String

Valid Values: LINEAR | EXPONENTIAL Id (p. 54)

The deployment strategy ID.

Type: String

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

Name (p. 54)

The name of the deployment strategy.

Type: String

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

ReplicateTo (p. 54)

Save the deployment strategy to a Systems Manager (SSM) document.

Type: String

Valid Values: NONE | SSM_DOCUMENT

Errors

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

BadRequestException

The input fails to satisfy the constraints speciﬁed by an AWS service.

GetDeploymentStrategy

HTTP Status Code: 400 InternalServerException

There was an internal failure in the AWS AppConﬁg service.

HTTP Status Code: 500 ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

Examples

Example

This example illustrates one usage of GetDeploymentStrategy.

Sample Request

GET /deploymentstrategies/1225qzk HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity

User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/

x86_64.amzn.2 prompt/off command/appconfig.get-deployment-strategy X-Amz-Date: 20210917T224000Z

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/

appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE

Sample Response

{ "Id": "1225qzk",

"Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR",

"GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "ReplicateTo": "SSM_DOCUMENT"

}

Request Syntax

GET /applications/ApplicationId/environments/EnvironmentId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ApplicationId (p. 58)

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

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

Required: Yes EnvironmentId (p. 58)

The ID of the environment that 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",

"Monitors": [ {

"AlarmArn": "string", "AlarmRoleArn": "string"

} ],

"Name": "string", "State": "string"

}

GetEnvironment

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 (p. 58) The application ID.

Type: String

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

Description (p. 58)

The description of the environment.

Type: String

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

Id (p. 58)

The environment ID.

Type: String

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

Monitors (p. 58)

Amazon CloudWatch alarms monitored during the deployment.

Type: Array of Monitor (p. 144) objects

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

Name (p. 58)

The name of the environment.

Type: String

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

State (p. 58)

The state of the environment. An environment can be in one of the following states:

READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK Type: String

Valid Values: READY_FOR_DEPLOYMENT | DEPLOYING | ROLLING_BACK | ROLLED_BACK

Errors

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

BadRequestException

The input fails to satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

GetEnvironment

InternalServerException

There was an internal failure in the AWS AppConﬁg service.

HTTP Status Code: 500 ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

Examples

Example

This example illustrates one usage of GetEnvironment.

Sample Request

GET /applications/abc1234/environments/54j1r29 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com

Accept-Encoding: identity

User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/

x86_64.amzn.2 prompt/off command/appconfig.get-environment X-Amz-Date: 20210917T224423Z

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/

appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE

Sample Response

{

"ApplicationId": "abc1234", "Id": "54j1r29",

"Name": "Example-Environment", "State": "ReadyForDeployment"

}

GetConﬁgurationProﬁle