AWS SDK for PHP 3.x

Client: Aws\AppConfig\AppConfigClient

Service ID: appconfig

Version: 2019-10-09

This page describes the parameters and results for the operations of the Amazon AppConfig (2019-10-09), and shows how to use the Aws\AppConfig\AppConfigClient object to call the described operations. This documentation is specific to the 2019-10-09 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateApplication ( array $params = [] )
Creates an application.
CreateConfigurationProfile ( array $params = [] )
Creates a configuration profile, which is information that enables AppConfig to access the configuration source.
CreateDeploymentStrategy ( array $params = [] )
Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets.
CreateEnvironment ( array $params = [] )
Creates an environment.
CreateExtension ( array $params = [] )
Creates an AppConfig extension.
CreateExtensionAssociation ( array $params = [] )
When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile.
CreateHostedConfigurationVersion ( array $params = [] )
Creates a new configuration in the AppConfig hosted configuration store.
DeleteApplication ( array $params = [] )
Deletes an application.
DeleteConfigurationProfile ( array $params = [] )
Deletes a configuration profile.
DeleteDeploymentStrategy ( array $params = [] )
Deletes a deployment strategy.
DeleteEnvironment ( array $params = [] )
Deletes an environment.
DeleteExtension ( array $params = [] )
Deletes an AppConfig extension.
DeleteExtensionAssociation ( array $params = [] )
Deletes an extension association.
DeleteHostedConfigurationVersion ( array $params = [] )
Deletes a version of a configuration from the AppConfig hosted configuration store.
GetApplication ( array $params = [] )
Retrieves information about an application.
GetConfiguration ( array $params = [] )
(Deprecated) Retrieves the latest deployed configuration.
GetConfigurationProfile ( array $params = [] )
Retrieves information about a configuration profile.
GetDeployment ( array $params = [] )
Retrieves information about a configuration deployment.
GetDeploymentStrategy ( array $params = [] )
Retrieves information about a deployment strategy.
GetEnvironment ( array $params = [] )
Retrieves information about an environment.
GetExtension ( array $params = [] )
Returns information about an AppConfig extension.
GetExtensionAssociation ( array $params = [] )
Returns information about an AppConfig extension association.
GetHostedConfigurationVersion ( array $params = [] )
Retrieves information about a specific configuration version.
ListApplications ( array $params = [] )
Lists all applications in your Amazon Web Services account.
ListConfigurationProfiles ( array $params = [] )
Lists the configuration profiles for an application.
ListDeploymentStrategies ( array $params = [] )
Lists deployment strategies.
ListDeployments ( array $params = [] )
Lists the deployments for an environment in descending deployment number order.
ListEnvironments ( array $params = [] )
Lists the environments for an application.
ListExtensionAssociations ( array $params = [] )
Lists all AppConfig extension associations in the account.
ListExtensions ( array $params = [] )
Lists all custom and Amazon Web Services authored AppConfig extensions in the account.
ListHostedConfigurationVersions ( array $params = [] )
Lists configurations stored in the AppConfig hosted configuration store by version.
ListTagsForResource ( array $params = [] )
Retrieves the list of key-value tags assigned to the resource.
StartDeployment ( array $params = [] )
Starts a deployment.
StopDeployment ( array $params = [] )
Stops a deployment.
TagResource ( array $params = [] )
Assigns metadata to an AppConfig resource.
UntagResource ( array $params = [] )
Deletes a tag key and value from an AppConfig resource.
UpdateApplication ( array $params = [] )
Updates an application.
UpdateConfigurationProfile ( array $params = [] )
Updates a configuration profile.
UpdateDeploymentStrategy ( array $params = [] )
Updates a deployment strategy.
UpdateEnvironment ( array $params = [] )
Updates an environment.
UpdateExtension ( array $params = [] )
Updates an AppConfig extension.
UpdateExtensionAssociation ( array $params = [] )
Updates an association.
ValidateConfiguration ( array $params = [] )
Uses the validators in a configuration profile to validate a configuration.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListApplications
ListConfigurationProfiles
ListDeploymentStrategies
ListDeployments
ListEnvironments
ListExtensionAssociations
ListExtensions
ListHostedConfigurationVersions

Operations

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Creates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.

Parameter Syntax

$result = $client->createApplication([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

Description

Type: string

A description of the application.

Name

Required: Yes
Type: string

A name for the application.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Result Syntax

[
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
]

Result Details

Members

Description

Type: string

The description of the application.

Id

Type: string

The application ID.

Name

Type: string

The application name.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To create an application

The following create-application example creates an application in AWS AppConfig.

$result = $client->createApplication([
    'Description' => 'An application used for creating an example.',
    'Name' => 'example-application',
]);

Result syntax:

[
    'Description' => 'An application used for creating an example.',
    'Id' => '339ohji',
    'Name' => 'example-application',
]

CreateConfigurationProfile

$result = $client->createConfigurationProfile([/* ... */]);
$promise = $client->createConfigurationProfileAsync([/* ... */]);

Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following:

Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store
Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket
Pipelines stored in CodePipeline
Secrets stored in Secrets Manager
Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store
Configuration data in SSM documents stored in the Systems Manager document store

A configuration profile includes the following information:

The URI location of the configuration data.
The Identity and Access Management (IAM) role that provides access to the configuration data.
A validator for the configuration data. Available validators include either a JSON Schema or an Amazon Web Services Lambda function.

For more information, see Create a Configuration and a Configuration Profile in the AppConfig User Guide.

Parameter Syntax

$result = $client->createConfigurationProfile([
    'ApplicationId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'LocationUri' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RetrievalRoleArn' => '<string>',
    'Tags' => ['<string>', ...],
    'Type' => '<string>',
    'Validators' => [
        [
            'Content' => '<string>', // REQUIRED
            'Type' => 'JSON_SCHEMA|LAMBDA', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

Description

Type: string

A description of the configuration profile.

LocationUri

Required: Yes
Type: string

A URI to locate the configuration. You can specify the following:

For the AppConfig hosted configuration store and for feature flags, specify hosted.
For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format ssm-parameter://<parameter name> or the ARN.
For an Secrets Manager secret, specify the URI in the following format: secrets-manager://<secret name>.
For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json
For an SSM document, specify either the document name in the format ssm-document://<document name> or the Amazon Resource Name (ARN).

Name

Required: Yes
Type: string

A name for the configuration profile.

RetrievalRoleArn

Type: string

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

A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Type

Type: string

The type of configurations contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type:

AWS.AppConfig.FeatureFlags

AWS.Freeform

Validators

Type: Array of Validator structures

A list of methods for validating the configuration.

Result Syntax

[
    'ApplicationId' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'LocationUri' => '<string>',
    'Name' => '<string>',
    'RetrievalRoleArn' => '<string>',
    'Type' => '<string>',
    'Validators' => [
        [
            'Content' => '<string>',
            'Type' => 'JSON_SCHEMA|LAMBDA',
        ],
        // ...
    ],
]

Result Details

Members

ApplicationId

Type: string

The application ID.

Description

Type: string

The configuration profile description.

Id

Type: string

The configuration profile ID.

LocationUri

Type: string

The URI location of the configuration.

Name

Type: string

The name of the configuration profile.

RetrievalRoleArn

Type: string

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

Type

Type: string

AWS.AppConfig.FeatureFlags

AWS.Freeform

Validators

Type: Array of Validator structures

A list of methods for validating the configuration.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To create a configuration profile

The following create-configuration-profile example creates a configuration profile using a configuration stored in Parameter Store, a capability of Systems Manager.

$result = $client->createConfigurationProfile([
    'ApplicationId' => '339ohji',
    'LocationUri' => 'ssm-parameter://Example-Parameter',
    'Name' => 'Example-Configuration-Profile',
    'RetrievalRoleArn' => 'arn:aws:iam::111122223333:role/Example-App-Config-Role',
]);

Result syntax:

[
    'ApplicationId' => '339ohji',
    'Id' => 'ur8hx2f',
    'LocationUri' => 'ssm-parameter://Example-Parameter',
    'Name' => 'Example-Configuration-Profile',
    'RetrievalRoleArn' => 'arn:aws:iam::111122223333:role/Example-App-Config-Role',
]

CreateDeploymentStrategy

$result = $client->createDeploymentStrategy([/* ... */]);
$promise = $client->createDeploymentStrategyAsync([/* ... */]);

Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

Parameter Syntax

$result = $client->createDeploymentStrategy([
    'DeploymentDurationInMinutes' => <integer>, // REQUIRED
    'Description' => '<string>',
    'FinalBakeTimeInMinutes' => <integer>,
    'GrowthFactor' => <float>, // REQUIRED
    'GrowthType' => 'LINEAR|EXPONENTIAL',
    'Name' => '<string>', // REQUIRED
    'ReplicateTo' => 'NONE|SSM_DOCUMENT',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

DeploymentDurationInMinutes

Required: Yes
Type: int

Total amount of time for a deployment to last.

Description

Type: string

A description of the deployment strategy.

FinalBakeTimeInMinutes

Type: int

Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

GrowthFactor

Required: Yes
Type: float

The percentage of targets to receive a deployed configuration during each interval.

GrowthType

Type: string

The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)

2*(2^1)

2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

Name

Required: Yes
Type: string

A name for the deployment strategy.

ReplicateTo

Type: string

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

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Result Syntax

[
    'DeploymentDurationInMinutes' => <integer>,
    'Description' => '<string>',
    'FinalBakeTimeInMinutes' => <integer>,
    'GrowthFactor' => <float>,
    'GrowthType' => 'LINEAR|EXPONENTIAL',
    'Id' => '<string>',
    'Name' => '<string>',
    'ReplicateTo' => 'NONE|SSM_DOCUMENT',
]

Result Details

Members

DeploymentDurationInMinutes

Type: int

Total amount of time the deployment lasted.

Description

Type: string

The description of the deployment strategy.

FinalBakeTimeInMinutes

Type: int

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

GrowthFactor

Type: float

The percentage of targets that received a deployed configuration during each interval.

GrowthType

Type: string

The algorithm used to define how percentage grew over time.

Id

Type: string

The deployment strategy ID.

Name

Type: string

The name of the deployment strategy.

ReplicateTo

Type: string

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

Errors

InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To create a deployment strategy

The following create-deployment-strategy example creates a deployment strategy called Example-Deployment that takes 15 minutes and deploys the configuration to 25% of the application at a time. The strategy is also copied to an SSM Document.

$result = $client->createDeploymentStrategy([
    'DeploymentDurationInMinutes' => 15,
    'GrowthFactor' => 25,
    'Name' => 'Example-Deployment',
    'ReplicateTo' => 'SSM_DOCUMENT',
]);

Result syntax:

[
    'DeploymentDurationInMinutes' => 15,
    'FinalBakeTimeInMinutes' => 0,
    'GrowthFactor' => 25,
    'GrowthType' => 'LINEAR',
    'Id' => '1225qzk',
    'Name' => 'Example-Deployment',
    'ReplicateTo' => 'SSM_DOCUMENT',
]

CreateEnvironment

$result = $client->createEnvironment([/* ... */]);
$promise = $client->createEnvironmentAsync([/* ... */]);

Creates an environment. For each application, you define one or more environments. An environment is a deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

Parameter Syntax

$result = $client->createEnvironment([
    'ApplicationId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Monitors' => [
        [
            'AlarmArn' => '<string>', // REQUIRED
            'AlarmRoleArn' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

Description

Type: string

A description of the environment.

Monitors

Type: Array of Monitor structures

Amazon CloudWatch alarms to monitor during the deployment process.

Name

Required: Yes
Type: string

A name for the environment.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Result Syntax

[
    'ApplicationId' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'Monitors' => [
        [
            'AlarmArn' => '<string>',
            'AlarmRoleArn' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>',
    'State' => 'READY_FOR_DEPLOYMENT|DEPLOYING|ROLLING_BACK|ROLLED_BACK',
]

Result Details

Members

ApplicationId

Type: string

The application ID.

Description

Type: string

The description of the environment.

Id

Type: string

The environment ID.

Monitors

Type: Array of Monitor structures

Amazon CloudWatch alarms monitored during the deployment.

Name

Type: string

The name of the environment.

State

Type: string

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

Errors

InternalServerException:
There was an internal failure in the AppConfig service.
ResourceNotFoundException:
The requested resource could not be found.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To create an environment

The following create-environment example creates an AWS AppConfig environment named Example-Environment using the application you created using create-application

$result = $client->createEnvironment([
    'ApplicationId' => '339ohji',
    'Name' => 'Example-Environment',
]);

Result syntax:

[
    'ApplicationId' => '339ohji',
    'Id' => '54j1r29',
    'Name' => 'Example-Environment',
    'State' => 'READY_FOR_DEPLOYMENT',
]

CreateExtension

$result = $client->createExtension([/* ... */]);
$promise = $client->createExtensionAsync([/* ... */]);

Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.

You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For most use cases, to create your own extension, you must create an Lambda function to perform any computation and processing defined in the extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

Parameter Syntax

$result = $client->createExtension([
    'Actions' => [ // REQUIRED
        '<ActionPoint>' => [
            [
                'Description' => '<string>',
                'Name' => '<string>',
                'RoleArn' => '<string>',
                'Uri' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'Description' => '<string>',
    'LatestVersionNumber' => <integer>,
    'Name' => '<string>', // REQUIRED
    'Parameters' => [
        '<Name>' => [
            'Description' => '<string>',
            'Required' => true || false,
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

Actions

Required: Yes
Type: Associative array of custom strings keys (ActionPoint) to Action structuress

The actions defined in the extension.

Description

Type: string

Information about the extension.

LatestVersionNumber

Type: int

You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.

Name

Required: Yes
Type: string

A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.

Parameters

Type: Associative array of custom strings keys (Name) to Parameter structures

The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

Result Syntax

[
    'Actions' => [
        '<ActionPoint>' => [
            [
                'Description' => '<string>',
                'Name' => '<string>',
                'RoleArn' => '<string>',
                'Uri' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'Arn' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Parameters' => [
        '<Name>' => [
            'Description' => '<string>',
            'Required' => true || false,
        ],
        // ...
    ],
    'VersionNumber' => <integer>,
]

Result Details

Members

Actions

Type: Associative array of custom strings keys (ActionPoint) to Action structuress

The actions defined in the extension.

Arn

Type: string

The system-generated Amazon Resource Name (ARN) for the extension.

Description

Type: string

Information about the extension.

Id

Type: string

The system-generated ID of the extension.

Name

Type: string

The extension name.

Parameters

Type: Associative array of custom strings keys (Name) to Parameter structures

VersionNumber

Type: int

The extension version number.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ServiceQuotaExceededException:
The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.
InternalServerException:
There was an internal failure in the AppConfig service.

CreateExtensionAssociation

$result = $client->createExtensionAssociation([/* ... */]);
$promise = $client->createExtensionAssociationAsync([/* ... */]);

When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the AppConfig deployment events to Amazon SNS Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

Parameter Syntax

$result = $client->createExtensionAssociation([
    'ExtensionIdentifier' => '<string>', // REQUIRED
    'ExtensionVersionNumber' => <integer>,
    'Parameters' => ['<string>', ...],
    'ResourceIdentifier' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

ExtensionIdentifier

Required: Yes
Type: string

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

ExtensionVersionNumber

Type: int

The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.

Parameters

Type: Associative array of custom strings keys (Name) to strings

The parameter names and values defined in the extensions. Extension parameters marked Required must be entered for this field.

ResourceIdentifier

Required: Yes
Type: string

The ARN of an application, configuration profile, or environment.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Adds one or more tags for the specified extension association. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

Result Syntax

[
    'Arn' => '<string>',
    'ExtensionArn' => '<string>',
    'ExtensionVersionNumber' => <integer>,
    'Id' => '<string>',
    'Parameters' => ['<string>', ...],
    'ResourceArn' => '<string>',
]

Result Details

Members

Arn

Type: string

The system-generated Amazon Resource Name (ARN) for the extension.

ExtensionArn

Type: string

The ARN of the extension defined in the association.

ExtensionVersionNumber

Type: int

The version number for the extension defined in the association.

Id

Type: string

The system-generated ID for the association.

Parameters

Type: Associative array of custom strings keys (Name) to strings

The parameter names and values defined in the association.

ResourceArn

Type: string

The ARNs of applications, configuration profiles, or environments defined in the association.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
ServiceQuotaExceededException:
The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.

CreateHostedConfigurationVersion

$result = $client->createHostedConfigurationVersion([/* ... */]);
$promise = $client->createHostedConfigurationVersionAsync([/* ... */]);

Creates a new configuration in the AppConfig hosted configuration store.

Parameter Syntax

$result = $client->createHostedConfigurationVersion([
    'ApplicationId' => '<string>', // REQUIRED
    'ConfigurationProfileId' => '<string>', // REQUIRED
    'Content' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'ContentType' => '<string>', // REQUIRED
    'Description' => '<string>',
    'LatestVersionNumber' => <integer>,
    'VersionLabel' => '<string>',
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

ConfigurationProfileId

Required: Yes
Type: string

The configuration profile ID.

Content

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The content of the configuration or the configuration data.

ContentType

Required: Yes
Type: string

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

Description

Type: string

A description of the configuration.

LatestVersionNumber

Type: int

An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.

VersionLabel

Type: string

An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".

Result Syntax

[
    'ApplicationId' => '<string>',
    'ConfigurationProfileId' => '<string>',
    'Content' => <string || resource || Psr\Http\Message\StreamInterface>,
    'ContentType' => '<string>',
    'Description' => '<string>',
    'VersionLabel' => '<string>',
    'VersionNumber' => <integer>,
]

Result Details

Members

ApplicationId

Type: string

The application ID.

ConfigurationProfileId

Type: string

The configuration profile ID.

Content

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The content of the configuration or the configuration data.

ContentType

Type: string

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

Description

Type: string

A description of the configuration.

VersionLabel

Type: string

A user-defined label for an AppConfig hosted configuration version.

VersionNumber

Type: int

The configuration version.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ServiceQuotaExceededException:
The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.
ResourceNotFoundException:
The requested resource could not be found.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
PayloadTooLargeException:
The configuration size is too large.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To create a hosted configuration version

The following create-hosted-configuration-version example creates a new configuration in the AWS AppConfig configuration store.

$result = $client->createHostedConfigurationVersion([
    'ApplicationId' => '339ohji',
    'ConfigurationProfileId' => 'ur8hx2f',
    'Content' => <BLOB>,
    'ContentType' => 'text',
    'LatestVersionNumber' => 1,
]);

Result syntax:

[
    'ApplicationId' => '339ohji',
    'ConfigurationProfileId' => 'ur8hx2f',
    'ContentType' => 'text',
    'VersionNumber' => 1,
]

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

Deletes an application. Deleting an application does not delete a configuration from a host.

Parameter Syntax

$result = $client->deleteApplication([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The ID of the application to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To delete an application

The following delete-application example deletes the specified application.

$result = $client->deleteApplication([
    'ApplicationId' => '339ohji',
]);

DeleteConfigurationProfile

$result = $client->deleteConfigurationProfile([/* ... */]);
$promise = $client->deleteConfigurationProfileAsync([/* ... */]);

Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.

Parameter Syntax

$result = $client->deleteConfigurationProfile([
    'ApplicationId' => '<string>', // REQUIRED
    'ConfigurationProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

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

ConfigurationProfileId

Required: Yes
Type: string

The ID of the configuration profile you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The requested resource could not be found.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To delete a configuration profile

The following delete-configuration-profile example deletes the specified configuration profile.

$result = $client->deleteConfigurationProfile([
    'ApplicationId' => '339ohji',
    'ConfigurationProfileId' => 'ur8hx2f',
]);

DeleteDeploymentStrategy

$result = $client->deleteDeploymentStrategy([/* ... */]);
$promise = $client->deleteDeploymentStrategyAsync([/* ... */]);

Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.

Parameter Syntax

$result = $client->deleteDeploymentStrategy([
    'DeploymentStrategyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeploymentStrategyId

Required: Yes
Type: string

The ID of the deployment strategy you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To delete a deployment strategy

The following delete-deployment-strategy example deletes the specified deployment strategy.

$result = $client->deleteDeploymentStrategy([
    'DeploymentStrategyId' => '1225qzk',
]);

DeleteEnvironment

$result = $client->deleteEnvironment([/* ... */]);
$promise = $client->deleteEnvironmentAsync([/* ... */]);

Deletes an environment. Deleting an environment does not delete a configuration from a host.

Parameter Syntax

$result = $client->deleteEnvironment([
    'ApplicationId' => '<string>', // REQUIRED
    'EnvironmentId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID that includes the environment that you want to delete.

EnvironmentId

Required: Yes
Type: string

The ID of the environment that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The requested resource could not be found.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To delete an environment

The following delete-environment example deletes the specified application environment.

$result = $client->deleteEnvironment([
    'ApplicationId' => '339ohji',
    'EnvironmentId' => '54j1r29',
]);

DeleteExtension

$result = $client->deleteExtension([/* ... */]);
$promise = $client->deleteExtensionAsync([/* ... */]);

Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.

Parameter Syntax

$result = $client->deleteExtension([
    'ExtensionIdentifier' => '<string>', // REQUIRED
    'VersionNumber' => <integer>,
]);

Parameter Details

Members

ExtensionIdentifier

Required: Yes
Type: string

The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.

VersionNumber

Type: int

A specific version of an extension to delete. If omitted, the highest version is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

DeleteExtensionAssociation

$result = $client->deleteExtensionAssociation([/* ... */]);
$promise = $client->deleteExtensionAssociationAsync([/* ... */]);

Deletes an extension association. This action doesn't delete extensions defined in the association.

Parameter Syntax

$result = $client->deleteExtensionAssociation([
    'ExtensionAssociationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ExtensionAssociationId

Required: Yes
Type: string

The ID of the extension association to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

DeleteHostedConfigurationVersion

$result = $client->deleteHostedConfigurationVersion([/* ... */]);
$promise = $client->deleteHostedConfigurationVersionAsync([/* ... */]);

Deletes a version of a configuration from the AppConfig hosted configuration store.

Parameter Syntax

$result = $client->deleteHostedConfigurationVersion([
    'ApplicationId' => '<string>', // REQUIRED
    'ConfigurationProfileId' => '<string>', // REQUIRED
    'VersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

ConfigurationProfileId

Required: Yes
Type: string

The configuration profile ID.

VersionNumber

Required: Yes
Type: int

The versions number to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To delete a hosted configuration version

The following delete-hosted-configuration-version example deletes a configuration version hosted in the AWS AppConfig configuration store.

$result = $client->deleteHostedConfigurationVersion([
    'ApplicationId' => '339ohji',
    'ConfigurationProfileId' => 'ur8hx2f',
    'VersionNumber' => 1,
]);

GetApplication

$result = $client->getApplication([/* ... */]);
$promise = $client->getApplicationAsync([/* ... */]);

Retrieves information about an application.

Parameter Syntax

$result = $client->getApplication([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The ID of the application you want to get.

Result Syntax

[
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
]

Result Details

Members

Description

Type: string

The description of the application.

Id

Type: string

The application ID.

Name

Type: string

The application name.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list details of an application

The following get-application example lists the details of the specified application.

$result = $client->getApplication([
    'ApplicationId' => '339ohji',
]);

Result syntax:

[
    'Id' => '339ohji',
    'Name' => 'example-application',
]

GetConfiguration

$result = $client->getConfiguration([/* ... */]);
$promise = $client->getConfigurationAsync([/* ... */]);

(Deprecated) Retrieves the latest deployed configuration.

Note the following important information.

This API action is deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead.
GetConfiguration is a priced call. For more information, see Pricing.

Parameter Syntax

$result = $client->getConfiguration([
    'Application' => '<string>', // REQUIRED
    'ClientConfigurationVersion' => '<string>',
    'ClientId' => '<string>', // REQUIRED
    'Configuration' => '<string>', // REQUIRED
    'Environment' => '<string>', // REQUIRED
]);

Parameter Details

Members

Application

Required: Yes
Type: string

The application to get. Specify either the application name or the application ID.

ClientConfigurationVersion

Type: string

The configuration version returned in the most recent GetConfiguration response.

AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to continue using GetConfiguration, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. The value to use for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to GetConfiguration.

For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.

ClientId

Required: Yes
Type: string

The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

Configuration

Required: Yes
Type: string

The configuration to get. Specify either the configuration name or the configuration ID.

Environment

Required: Yes
Type: string

The environment to get. Specify either the environment name or the environment ID.

Result Syntax

[
    'ConfigurationVersion' => '<string>',
    'Content' => <string || resource || Psr\Http\Message\StreamInterface>,
    'ContentType' => '<string>',
]

Result Details

Members

ConfigurationVersion

Type: string

The configuration version.

Content

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The content of the configuration or the configuration data.

The Content attribute only contains data if the system finds new or updated configuration data. If there is no new or updated data and ClientConfigurationVersion matches the version of the current configuration, AppConfig returns a 204 No Content HTTP response code and the Content value will be empty.

ContentType

Type: string

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To retrieve configuration details

The following get-configuration example returns the configuration details of the example application. On subsequent calls to get-configuration, use the client-configuration-version parameter to only update the configuration of your application if the version has changed. Only updating the configuration when the version has changed avoids excess charges incurred by calling get-configuration.

$result = $client->getConfiguration([
    'Application' => 'example-application',
    'ClientId' => 'example-id',
    'Configuration' => 'Example-Configuration-Profile',
    'Environment' => 'Example-Environment',
]);

Result syntax:

[
    'ConfigurationVersion' => '1',
    'ContentType' => 'application/octet-stream',
]

GetConfigurationProfile

$result = $client->getConfigurationProfile([/* ... */]);
$promise = $client->getConfigurationProfileAsync([/* ... */]);

Retrieves information about a configuration profile.

Parameter Syntax

$result = $client->getConfigurationProfile([
    'ApplicationId' => '<string>', // REQUIRED
    'ConfigurationProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

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

ConfigurationProfileId

Required: Yes
Type: string

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

Result Syntax

[
    'ApplicationId' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'LocationUri' => '<string>',
    'Name' => '<string>',
    'RetrievalRoleArn' => '<string>',
    'Type' => '<string>',
    'Validators' => [
        [
            'Content' => '<string>',
            'Type' => 'JSON_SCHEMA|LAMBDA',
        ],
        // ...
    ],
]

Result Details

Members

ApplicationId

Type: string

The application ID.

Description

Type: string

The configuration profile description.

Id

Type: string

The configuration profile ID.

LocationUri

Type: string

The URI location of the configuration.

Name

Type: string

The name of the configuration profile.

RetrievalRoleArn

Type: string

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

Type

Type: string

AWS.AppConfig.FeatureFlags

AWS.Freeform

Validators

Type: Array of Validator structures

A list of methods for validating the configuration.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To retrieve configuration profile details

The following get-configuration-profile example returns the details of the specified configuration profile.

$result = $client->getConfigurationProfile([
    'ApplicationId' => '339ohji',
    'ConfigurationProfileId' => 'ur8hx2f',
]);

Result syntax:

[
    'ApplicationId' => '339ohji',
    'Id' => 'ur8hx2f',
    'LocationUri' => 'ssm-parameter://Example-Parameter',
    'Name' => 'Example-Configuration-Profile',
    'RetrievalRoleArn' => 'arn:aws:iam::111122223333:role/Example-App-Config-Role',
]

GetDeployment

$result = $client->getDeployment([/* ... */]);
$promise = $client->getDeploymentAsync([/* ... */]);

Retrieves information about a configuration deployment.

Parameter Syntax

$result = $client->getDeployment([
    'ApplicationId' => '<string>', // REQUIRED
    'DeploymentNumber' => <integer>, // REQUIRED
    'EnvironmentId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

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

DeploymentNumber

Required: Yes
Type: int

The sequence number of the deployment.

EnvironmentId

Required: Yes
Type: string

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

Result Syntax

[
    'ApplicationId' => '<string>',
    'AppliedExtensions' => [
        [
            'ExtensionAssociationId' => '<string>',
            'ExtensionId' => '<string>',
            'Parameters' => ['<string>', ...],
            'VersionNumber' => <integer>,
        ],
        // ...
    ],
    'CompletedAt' => <DateTime>,
    'ConfigurationLocationUri' => '<string>',
    'ConfigurationName' => '<string>',
    'ConfigurationProfileId' => '<string>',
    'ConfigurationVersion' => '<string>',
    'DeploymentDurationInMinutes' => <integer>,
    'DeploymentNumber' => <integer>,
    'DeploymentStrategyId' => '<string>',
    'Description' => '<string>',
    'EnvironmentId' => '<string>',
    'EventLog' => [
        [
            'ActionInvocations' => [
                [
                    'ActionName' => '<string>',
                    'ErrorCode' => '<string>',
                    'ErrorMessage' => '<string>',
                    'ExtensionIdentifier' => '<string>',
                    'InvocationId' => '<string>',
                    'RoleArn' => '<string>',
                    'Uri' => '<string>',
                ],
                // ...
            ],
            'Description' => '<string>',
            'EventType' => 'PERCENTAGE_UPDATED|ROLLBACK_STARTED|ROLLBACK_COMPLETED|BAKE_TIME_STARTED|DEPLOYMENT_STARTED|DEPLOYMENT_COMPLETED',
            'OccurredAt' => <DateTime>,
            'TriggeredBy' => 'USER|APPCONFIG|CLOUDWATCH_ALARM|INTERNAL_ERROR',
        ],
        // ...
    ],
    'FinalBakeTimeInMinutes' => <integer>,
    'GrowthFactor' => <float>,
    'GrowthType' => 'LINEAR|EXPONENTIAL',
    'KmsKeyArn' => '<string>',
    'KmsKeyIdentifier' => '<string>',
    'PercentageComplete' => <float>,
    'StartedAt' => <DateTime>,
    'State' => 'BAKING|VALIDATING|DEPLOYING|COMPLETE|ROLLING_BACK|ROLLED_BACK',
]

Result Details

Members

ApplicationId

Type: string

The ID of the application that was deployed.

AppliedExtensions

Type: Array of AppliedExtension structures

A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

CompletedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the deployment completed.

ConfigurationLocationUri

Type: string

Information about the source location of the configuration.

ConfigurationName

Type: string

The name of the configuration.

ConfigurationProfileId

Type: string

The ID of the configuration profile that was deployed.

ConfigurationVersion

Type: string

The configuration version that was deployed.

DeploymentDurationInMinutes

Type: int

Total amount of time the deployment lasted.

DeploymentNumber

Type: int

The sequence number of the deployment.

DeploymentStrategyId

Type: string

The ID of the deployment strategy that was deployed.

Description

Type: string

The description of the deployment.

EnvironmentId

Type: string

The ID of the environment that was deployed.

EventLog

Type: Array of DeploymentEvent structures

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

FinalBakeTimeInMinutes

Type: int

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

GrowthFactor

Type: float

The percentage of targets to receive a deployed configuration during each interval.

GrowthType

Type: string

The algorithm used to define how percentage grew over time.

KmsKeyArn

Type: string

The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.

KmsKeyIdentifier

Type: string

The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

PercentageComplete

Type: float

The percentage of targets for which the deployment is available.

StartedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the deployment started.

State

Type: string

The state of the deployment.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To retrieve deployment details

The following get-deployment example lists details of the deployment to the application in the specified environment and deployment.

$result = $client->getDeployment([
    'ApplicationId' => '339ohji',
    'DeploymentNumber' => 1,
    'EnvironmentId' => '54j1r29',
]);

Result syntax:

[
    'ApplicationId' => '339ohji',
    'CompletedAt' => ,
    'ConfigurationLocationUri' => 'ssm-parameter://Example-Parameter',
    'ConfigurationName' => 'Example-Configuration-Profile',
    'ConfigurationProfileId' => 'ur8hx2f',
    'ConfigurationVersion' => '1',
    'DeploymentDurationInMinutes' => 15,
    'DeploymentNumber' => 1,
    'DeploymentStrategyId' => '1225qzk',
    'EnvironmentId' => '54j1r29',
    'EventLog' => [
        [
            'Description' => 'Deployment completed',
            'EventType' => 'DEPLOYMENT_COMPLETED',
            'OccurredAt' => ,
            'TriggeredBy' => 'APPCONFIG',
        ],
        [
            'Description' => 'Deployment bake time started',
            'EventType' => 'BAKE_TIME_STARTED',
            'OccurredAt' => ,
            'TriggeredBy' => 'APPCONFIG',
        ],
        [
            'Description' => 'Configuration available to 100.00% of clients',
            'EventType' => 'PERCENTAGE_UPDATED',
            'OccurredAt' => ,
            'TriggeredBy' => 'APPCONFIG',
        ],
        [
            'Description' => 'Configuration available to 75.00% of clients',
            'EventType' => 'PERCENTAGE_UPDATED',
            'OccurredAt' => ,
            'TriggeredBy' => 'APPCONFIG',
        ],
        [
            'Description' => 'Configuration available to 50.00% of clients',
            'EventType' => 'PERCENTAGE_UPDATED',
            'OccurredAt' => ,
            'TriggeredBy' => 'APPCONFIG',
        ],
        [
            'Description' => 'Configuration available to 25.00% of clients',
            'EventType' => 'PERCENTAGE_UPDATED',
            'OccurredAt' => ,
            'TriggeredBy' => 'APPCONFIG',
        ],
        [
            'Description' => 'Deployment started',
            'EventType' => 'DEPLOYMENT_STARTED',
            'OccurredAt' => ,
            'TriggeredBy' => 'USER',
        ],
    ],
    'FinalBakeTimeInMinutes' => 0,
    'GrowthFactor' => 25,
    'GrowthType' => 'LINEAR',
    'PercentageComplete' => 100,
    'StartedAt' => ,
    'State' => 'COMPLETE',
]

GetDeploymentStrategy

$result = $client->getDeploymentStrategy([/* ... */]);
$promise = $client->getDeploymentStrategyAsync([/* ... */]);

Retrieves information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

Parameter Syntax

$result = $client->getDeploymentStrategy([
    'DeploymentStrategyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeploymentStrategyId

Required: Yes
Type: string

The ID of the deployment strategy to get.

Result Syntax

[
    'DeploymentDurationInMinutes' => <integer>,
    'Description' => '<string>',
    'FinalBakeTimeInMinutes' => <integer>,
    'GrowthFactor' => <float>,
    'GrowthType' => 'LINEAR|EXPONENTIAL',
    'Id' => '<string>',
    'Name' => '<string>',
    'ReplicateTo' => 'NONE|SSM_DOCUMENT',
]

Result Details

Members

DeploymentDurationInMinutes

Type: int

Total amount of time the deployment lasted.

Description

Type: string

The description of the deployment strategy.

FinalBakeTimeInMinutes

Type: int

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

GrowthFactor

Type: float

The percentage of targets that received a deployed configuration during each interval.

GrowthType

Type: string

The algorithm used to define how percentage grew over time.

Id

Type: string

The deployment strategy ID.

Name

Type: string

The name of the deployment strategy.

ReplicateTo

Type: string

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

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To retrieve details of a deployment strategy

The following get-deployment-strategy example lists the details of the specified deployment strategy.

$result = $client->getDeploymentStrategy([
    'DeploymentStrategyId' => '1225qzk',
]);

Result syntax:

[
    'DeploymentDurationInMinutes' => 15,
    'FinalBakeTimeInMinutes' => 0,
    'GrowthFactor' => 25,
    'GrowthType' => 'LINEAR',
    'Id' => '1225qzk',
    'Name' => 'Example-Deployment',
    'ReplicateTo' => 'SSM_DOCUMENT',
]

GetEnvironment

$result = $client->getEnvironment([/* ... */]);
$promise = $client->getEnvironmentAsync([/* ... */]);

Retrieves information about an environment. An environment is a deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.

Parameter Syntax

$result = $client->getEnvironment([
    'ApplicationId' => '<string>', // REQUIRED
    'EnvironmentId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

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

EnvironmentId

Required: Yes
Type: string

The ID of the environment that you want to get.

Result Syntax

[
    'ApplicationId' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'Monitors' => [
        [
            'AlarmArn' => '<string>',
            'AlarmRoleArn' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>',
    'State' => 'READY_FOR_DEPLOYMENT|DEPLOYING|ROLLING_BACK|ROLLED_BACK',
]

Result Details

Members

ApplicationId

Type: string

The application ID.

Description

Type: string

The description of the environment.

Id

Type: string

The environment ID.

Monitors

Type: Array of Monitor structures

Amazon CloudWatch alarms monitored during the deployment.

Name

Type: string

The name of the environment.

State

Type: string

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To retrieve environment details

The following get-environment example returns the details and state of the specified environment.

$result = $client->getEnvironment([
    'ApplicationId' => '339ohji',
    'EnvironmentId' => '54j1r29',
]);

Result syntax:

[
    'ApplicationId' => '339ohji',
    'Id' => '54j1r29',
    'Name' => 'Example-Environment',
    'State' => 'READY_FOR_DEPLOYMENT',
]

GetExtension

$result = $client->getExtension([/* ... */]);
$promise = $client->getExtensionAsync([/* ... */]);

Returns information about an AppConfig extension.

Parameter Syntax

$result = $client->getExtension([
    'ExtensionIdentifier' => '<string>', // REQUIRED
    'VersionNumber' => <integer>,
]);

Parameter Details

Members

ExtensionIdentifier

Required: Yes
Type: string

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

VersionNumber

Type: int

The extension version number. If no version number was defined, AppConfig uses the highest version.

Result Syntax

[
    'Actions' => [
        '<ActionPoint>' => [
            [
                'Description' => '<string>',
                'Name' => '<string>',
                'RoleArn' => '<string>',
                'Uri' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'Arn' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Parameters' => [
        '<Name>' => [
            'Description' => '<string>',
            'Required' => true || false,
        ],
        // ...
    ],
    'VersionNumber' => <integer>,
]

Result Details

Members

Actions

Type: Associative array of custom strings keys (ActionPoint) to Action structuress

The actions defined in the extension.

Arn

Type: string

The system-generated Amazon Resource Name (ARN) for the extension.

Description

Type: string

Information about the extension.

Id

Type: string

The system-generated ID of the extension.

Name

Type: string

The extension name.

Parameters

Type: Associative array of custom strings keys (Name) to Parameter structures

VersionNumber

Type: int

The extension version number.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

GetExtensionAssociation

$result = $client->getExtensionAssociation([/* ... */]);
$promise = $client->getExtensionAssociationAsync([/* ... */]);

Returns information about an AppConfig extension association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

Parameter Syntax

$result = $client->getExtensionAssociation([
    'ExtensionAssociationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ExtensionAssociationId

Required: Yes
Type: string

The extension association ID to get.

Result Syntax

[
    'Arn' => '<string>',
    'ExtensionArn' => '<string>',
    'ExtensionVersionNumber' => <integer>,
    'Id' => '<string>',
    'Parameters' => ['<string>', ...],
    'ResourceArn' => '<string>',
]

Result Details

Members

Arn

Type: string

The system-generated Amazon Resource Name (ARN) for the extension.

ExtensionArn

Type: string

The ARN of the extension defined in the association.

ExtensionVersionNumber

Type: int

The version number for the extension defined in the association.

Id

Type: string

The system-generated ID for the association.

Parameters

Type: Associative array of custom strings keys (Name) to strings

The parameter names and values defined in the association.

ResourceArn

Type: string

The ARNs of applications, configuration profiles, or environments defined in the association.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

GetHostedConfigurationVersion

$result = $client->getHostedConfigurationVersion([/* ... */]);
$promise = $client->getHostedConfigurationVersionAsync([/* ... */]);

Retrieves information about a specific configuration version.

Parameter Syntax

$result = $client->getHostedConfigurationVersion([
    'ApplicationId' => '<string>', // REQUIRED
    'ConfigurationProfileId' => '<string>', // REQUIRED
    'VersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

ConfigurationProfileId

Required: Yes
Type: string

The configuration profile ID.

VersionNumber

Required: Yes
Type: int

The version.

Result Syntax

[
    'ApplicationId' => '<string>',
    'ConfigurationProfileId' => '<string>',
    'Content' => <string || resource || Psr\Http\Message\StreamInterface>,
    'ContentType' => '<string>',
    'Description' => '<string>',
    'VersionLabel' => '<string>',
    'VersionNumber' => <integer>,
]

Result Details

Members

ApplicationId

Type: string

The application ID.

ConfigurationProfileId

Type: string

The configuration profile ID.

Content

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The content of the configuration or the configuration data.

ContentType

Type: string

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

Description

Type: string

A description of the configuration.

VersionLabel

Type: string

A user-defined label for an AppConfig hosted configuration version.

VersionNumber

Type: int

The configuration version.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To retrieve hosted configuration details

The following get-hosted-configuration-version example retrieves the configuration details of the AWS AppConfig hosted configuration.

$result = $client->getHostedConfigurationVersion([
    'ApplicationId' => '339ohji',
    'ConfigurationProfileId' => 'ur8hx2f',
    'VersionNumber' => 1,
]);

Result syntax:

[
    'ApplicationId' => '339ohji',
    'ConfigurationProfileId' => 'ur8hx2f',
    'ContentType' => 'application/json',
    'VersionNumber' => 1,
]

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

Lists all applications in your Amazon Web Services account.

Parameter Syntax

$result = $client->listApplications([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results.

Result Syntax

[
    'Items' => [
        [
            'Description' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Items

Type: Array of Application structures

The elements from this collection.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list the available applications

The following list-applications example lists the available applications in your AWS account.

$result = $client->listApplications([
]);

Result syntax:

[
    'Items' => [
        [
            'Description' => 'An application used for creating an example.',
            'Id' => '339ohji',
            'Name' => 'test-application',
        ],
        [
            'Id' => 'rwalwu7',
            'Name' => 'Test-Application',
        ],
    ],
]

ListConfigurationProfiles

$result = $client->listConfigurationProfiles([/* ... */]);
$promise = $client->listConfigurationProfilesAsync([/* ... */]);

Lists the configuration profiles for an application.

Parameter Syntax

$result = $client->listConfigurationProfiles([
    'ApplicationId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Type' => '<string>',
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Type

Type: string

A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a freeform configuration.

Result Syntax

[
    'Items' => [
        [
            'ApplicationId' => '<string>',
            'Id' => '<string>',
            'LocationUri' => '<string>',
            'Name' => '<string>',
            'Type' => '<string>',
            'ValidatorTypes' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Items

Type: Array of ConfigurationProfileSummary structures

The elements from this collection.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list the available configuration profiles

The following list-configuration-profiles example lists the available configuration profiles for the specified application.

$result = $client->listConfigurationProfiles([
    'ApplicationId' => '339ohji',
]);

Result syntax:

[
    'Items' => [
        [
            'ApplicationId' => '339ohji',
            'Id' => 'ur8hx2f',
            'LocationUri' => 'ssm-parameter://Example-Parameter',
            'Name' => 'Example-Configuration-Profile',
        ],
    ],
]

ListDeploymentStrategies

$result = $client->listDeploymentStrategies([/* ... */]);
$promise = $client->listDeploymentStrategiesAsync([/* ... */]);

Lists deployment strategies.

Parameter Syntax

$result = $client->listDeploymentStrategies([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'Items' => [
        [
            'DeploymentDurationInMinutes' => <integer>,
            'Description' => '<string>',
            'FinalBakeTimeInMinutes' => <integer>,
            'GrowthFactor' => <float>,
            'GrowthType' => 'LINEAR|EXPONENTIAL',
            'Id' => '<string>',
            'Name' => '<string>',
            'ReplicateTo' => 'NONE|SSM_DOCUMENT',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Items

Type: Array of DeploymentStrategy structures

The elements from this collection.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list the available deployment strategies

The following list-deployment-strategies example lists the available deployment strategies in your AWS account.

$result = $client->listDeploymentStrategies([
]);

Result syntax:

[
    'Items' => [
        [
            'DeploymentDurationInMinutes' => 15,
            'FinalBakeTimeInMinutes' => 0,
            'GrowthFactor' => 25,
            'GrowthType' => 'LINEAR',
            'Id' => '1225qzk',
            'Name' => 'Example-Deployment',
            'ReplicateTo' => 'SSM_DOCUMENT',
        ],
    ],
]

ListDeployments

$result = $client->listDeployments([/* ... */]);
$promise = $client->listDeploymentsAsync([/* ... */]);

Lists the deployments for an environment in descending deployment number order.

Parameter Syntax

$result = $client->listDeployments([
    'ApplicationId' => '<string>', // REQUIRED
    'EnvironmentId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

EnvironmentId

Required: Yes
Type: string

The environment ID.

MaxResults

Type: int

The maximum number of items that may be returned for this call. If there are items that have not yet been returned, the response will include a non-null NextToken that you can provide in a subsequent call to get the next set of results.

NextToken

Type: string

The token returned by a prior call to this operation indicating the next set of results to be returned. If not specified, the operation will return the first set of results.

Result Syntax

[
    'Items' => [
        [
            'CompletedAt' => <DateTime>,
            'ConfigurationName' => '<string>',
            'ConfigurationVersion' => '<string>',
            'DeploymentDurationInMinutes' => <integer>,
            'DeploymentNumber' => <integer>,
            'FinalBakeTimeInMinutes' => <integer>,
            'GrowthFactor' => <float>,
            'GrowthType' => 'LINEAR|EXPONENTIAL',
            'PercentageComplete' => <float>,
            'StartedAt' => <DateTime>,
            'State' => 'BAKING|VALIDATING|DEPLOYING|COMPLETE|ROLLING_BACK|ROLLED_BACK',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Items

Type: Array of DeploymentSummary structures

The elements from this collection.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list the available deployments

The following list-deployments example lists the available deployments in your AWS account for the specified application and environment.

$result = $client->listDeployments([
    'ApplicationId' => '339ohji',
    'EnvironmentId' => '54j1r29',
]);

Result syntax:

[
    'Items' => [
        [
            'CompletedAt' => ,
            'ConfigurationName' => 'Example-Configuration-Profile',
            'ConfigurationVersion' => '1',
            'DeploymentDurationInMinutes' => 15,
            'DeploymentNumber' => 1,
            'FinalBakeTimeInMinutes' => 0,
            'GrowthFactor' => 25,
            'GrowthType' => 'LINEAR',
            'PercentageComplete' => 100,
            'StartedAt' => ,
            'State' => 'COMPLETE',
        ],
    ],
]

ListEnvironments

$result = $client->listEnvironments([/* ... */]);
$promise = $client->listEnvironmentsAsync([/* ... */]);

Lists the environments for an application.

Parameter Syntax

$result = $client->listEnvironments([
    'ApplicationId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'Items' => [
        [
            'ApplicationId' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'Monitors' => [
                [
                    'AlarmArn' => '<string>',
                    'AlarmRoleArn' => '<string>',
                ],
                // ...
            ],
            'Name' => '<string>',
            'State' => 'READY_FOR_DEPLOYMENT|DEPLOYING|ROLLING_BACK|ROLLED_BACK',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Items

Type: Array of Environment structures

The elements from this collection.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list the available environments

The following list-environments example lists the available environments in your AWS account for the specified application.

$result = $client->listEnvironments([
    'ApplicationId' => '339ohji',
]);

Result syntax:

[
    'Items' => [
        [
            'ApplicationId' => '339ohji',
            'Id' => '54j1r29',
            'Name' => 'Example-Environment',
            'State' => 'READY_FOR_DEPLOYMENT',
        ],
    ],
]

ListExtensionAssociations

$result = $client->listExtensionAssociations([/* ... */]);
$promise = $client->listExtensionAssociationsAsync([/* ... */]);

Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

Parameter Syntax

$result = $client->listExtensionAssociations([
    'ExtensionIdentifier' => '<string>',
    'ExtensionVersionNumber' => <integer>,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceIdentifier' => '<string>',
]);

Parameter Details

Members

ExtensionIdentifier

Type: string

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

ExtensionVersionNumber

Type: int

The version number for the extension defined in the association.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results or pass null to get the first set of results.

ResourceIdentifier

Type: string

The ARN of an application, configuration profile, or environment.

Result Syntax

[
    'Items' => [
        [
            'ExtensionArn' => '<string>',
            'Id' => '<string>',
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Items

Type: Array of ExtensionAssociationSummary structures

The list of extension associations. Each item represents an extension association to an application, environment, or configuration profile.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListExtensions

$result = $client->listExtensions([/* ... */]);
$promise = $client->listExtensionsAsync([/* ... */]);

Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

Parameter Syntax

$result = $client->listExtensions([
    'MaxResults' => <integer>,
    'Name' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Name

Type: string

The extension name.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'Items' => [
        [
            'Arn' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'VersionNumber' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Items

Type: Array of ExtensionSummary structures

The list of available extensions. The list includes Amazon Web Services authored and user-created extensions.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListHostedConfigurationVersions

$result = $client->listHostedConfigurationVersions([/* ... */]);
$promise = $client->listHostedConfigurationVersionsAsync([/* ... */]);

Lists configurations stored in the AppConfig hosted configuration store by version.

Parameter Syntax

$result = $client->listHostedConfigurationVersions([
    'ApplicationId' => '<string>', // REQUIRED
    'ConfigurationProfileId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'VersionLabel' => '<string>',
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

ConfigurationProfileId

Required: Yes
Type: string

The configuration profile ID.

MaxResults

Type: int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

Type: string

A token to start the list. Use this token to get the next set of results.

VersionLabel

Type: string

An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only an exact match is returned.

Result Syntax

[
    'Items' => [
        [
            'ApplicationId' => '<string>',
            'ConfigurationProfileId' => '<string>',
            'ContentType' => '<string>',
            'Description' => '<string>',
            'VersionLabel' => '<string>',
            'VersionNumber' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Items

Type: Array of HostedConfigurationVersionSummary structures

The elements from this collection.

NextToken

Type: string

The token for the next set of items to return. Use this token to get the next set of results.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To list the available hosted configuration versions

The following list-hosted-configuration-versions example lists the configurations versions hosted in the AWS AppConfig hosted configuration store for the specified application and configuration profile.

$result = $client->listHostedConfigurationVersions([
    'ApplicationId' => '339ohji',
    'ConfigurationProfileId' => 'ur8hx2f',
]);

Result syntax:

[
    'Items' => [
        [
            'ApplicationId' => '339ohji',
            'ConfigurationProfileId' => 'ur8hx2f',
            'ContentType' => 'application/json',
            'VersionNumber' => 1,
        ],
    ],
]

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves the list of key-value tags assigned to the resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The resource ARN.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Metadata to assign to AppConfig resources. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Errors

ResourceNotFoundException:
The requested resource could not be found.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To list the tags of an application

The following list-tags-for-resource example lists the tags of a specified application.

$result = $client->listTagsForResource([
    'ResourceArn' => 'arn:aws:appconfig:us-east-1:111122223333:application/339ohji',
]);

Result syntax:

[
    'Tags' => [
        'group1' => '1',
    ],
]

StartDeployment

$result = $client->startDeployment([/* ... */]);
$promise = $client->startDeploymentAsync([/* ... */]);

Starts a deployment.

Parameter Syntax

$result = $client->startDeployment([
    'ApplicationId' => '<string>', // REQUIRED
    'ConfigurationProfileId' => '<string>', // REQUIRED
    'ConfigurationVersion' => '<string>', // REQUIRED
    'DeploymentStrategyId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'EnvironmentId' => '<string>', // REQUIRED
    'KmsKeyIdentifier' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

ConfigurationProfileId

Required: Yes
Type: string

The configuration profile ID.

ConfigurationVersion

Required: Yes
Type: string

The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label.

DeploymentStrategyId

Required: Yes
Type: string

The deployment strategy ID.

Description

Type: string

A description of the deployment.

EnvironmentId

Required: Yes
Type: string

The environment ID.

KmsKeyIdentifier

Type: string

The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Result Syntax

[
    'ApplicationId' => '<string>',
    'AppliedExtensions' => [
        [
            'ExtensionAssociationId' => '<string>',
            'ExtensionId' => '<string>',
            'Parameters' => ['<string>', ...],
            'VersionNumber' => <integer>,
        ],
        // ...
    ],
    'CompletedAt' => <DateTime>,
    'ConfigurationLocationUri' => '<string>',
    'ConfigurationName' => '<string>',
    'ConfigurationProfileId' => '<string>',
    'ConfigurationVersion' => '<string>',
    'DeploymentDurationInMinutes' => <integer>,
    'DeploymentNumber' => <integer>,
    'DeploymentStrategyId' => '<string>',
    'Description' => '<string>',
    'EnvironmentId' => '<string>',
    'EventLog' => [
        [
            'ActionInvocations' => [
                [
                    'ActionName' => '<string>',
                    'ErrorCode' => '<string>',
                    'ErrorMessage' => '<string>',
                    'ExtensionIdentifier' => '<string>',
                    'InvocationId' => '<string>',
                    'RoleArn' => '<string>',
                    'Uri' => '<string>',
                ],
                // ...
            ],
            'Description' => '<string>',
            'EventType' => 'PERCENTAGE_UPDATED|ROLLBACK_STARTED|ROLLBACK_COMPLETED|BAKE_TIME_STARTED|DEPLOYMENT_STARTED|DEPLOYMENT_COMPLETED',
            'OccurredAt' => <DateTime>,
            'TriggeredBy' => 'USER|APPCONFIG|CLOUDWATCH_ALARM|INTERNAL_ERROR',
        ],
        // ...
    ],
    'FinalBakeTimeInMinutes' => <integer>,
    'GrowthFactor' => <float>,
    'GrowthType' => 'LINEAR|EXPONENTIAL',
    'KmsKeyArn' => '<string>',
    'KmsKeyIdentifier' => '<string>',
    'PercentageComplete' => <float>,
    'StartedAt' => <DateTime>,
    'State' => 'BAKING|VALIDATING|DEPLOYING|COMPLETE|ROLLING_BACK|ROLLED_BACK',
]

Result Details

Members

ApplicationId

Type: string

The ID of the application that was deployed.

AppliedExtensions

Type: Array of AppliedExtension structures

CompletedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the deployment completed.

ConfigurationLocationUri

Type: string

Information about the source location of the configuration.

ConfigurationName

Type: string

The name of the configuration.

ConfigurationProfileId

Type: string

The ID of the configuration profile that was deployed.

ConfigurationVersion

Type: string

The configuration version that was deployed.

DeploymentDurationInMinutes

Type: int

Total amount of time the deployment lasted.

DeploymentNumber

Type: int

The sequence number of the deployment.

DeploymentStrategyId

Type: string

The ID of the deployment strategy that was deployed.

Description

Type: string

The description of the deployment.

EnvironmentId

Type: string

The ID of the environment that was deployed.

EventLog

Type: Array of DeploymentEvent structures

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

FinalBakeTimeInMinutes

Type: int

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

GrowthFactor

Type: float

The percentage of targets to receive a deployed configuration during each interval.

GrowthType

Type: string

The algorithm used to define how percentage grew over time.

KmsKeyArn

Type: string

KmsKeyIdentifier

Type: string

The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

PercentageComplete

Type: float

The percentage of targets for which the deployment is available.

StartedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the deployment started.

State

Type: string

The state of the deployment.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To start a configuration deployment

The following start-deployment example starts a deployment to the application using the specified environment, deployment strategy, and configuration profile.

$result = $client->startDeployment([
    'ApplicationId' => '339ohji',
    'ConfigurationProfileId' => 'ur8hx2f',
    'ConfigurationVersion' => '1',
    'DeploymentStrategyId' => '1225qzk',
    'Description' => '',
    'EnvironmentId' => '54j1r29',
    'Tags' => [
    ],
]);

Result syntax:

[
    'ApplicationId' => '339ohji',
    'ConfigurationLocationUri' => 'ssm-parameter://Example-Parameter',
    'ConfigurationName' => 'Example-Configuration-Profile',
    'ConfigurationProfileId' => 'ur8hx2f',
    'ConfigurationVersion' => '1',
    'DeploymentDurationInMinutes' => 15,
    'DeploymentNumber' => 1,
    'DeploymentStrategyId' => '1225qzk',
    'EnvironmentId' => '54j1r29',
    'EventLog' => [
        [
            'Description' => 'Deployment started',
            'EventType' => 'DEPLOYMENT_STARTED',
            'OccurredAt' => ,
            'TriggeredBy' => 'USER',
        ],
    ],
    'FinalBakeTimeInMinutes' => 0,
    'GrowthFactor' => 25,
    'GrowthType' => 'LINEAR',
    'PercentageComplete' => 1,
    'StartedAt' => ,
    'State' => 'DEPLOYING',
]

StopDeployment

$result = $client->stopDeployment([/* ... */]);
$promise = $client->stopDeploymentAsync([/* ... */]);

Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This action moves the deployment to a status of ROLLED_BACK.

Parameter Syntax

$result = $client->stopDeployment([
    'ApplicationId' => '<string>', // REQUIRED
    'DeploymentNumber' => <integer>, // REQUIRED
    'EnvironmentId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

DeploymentNumber

Required: Yes
Type: int

The sequence number of the deployment.

EnvironmentId

Required: Yes
Type: string

The environment ID.

Result Syntax

[
    'ApplicationId' => '<string>',
    'AppliedExtensions' => [
        [
            'ExtensionAssociationId' => '<string>',
            'ExtensionId' => '<string>',
            'Parameters' => ['<string>', ...],
            'VersionNumber' => <integer>,
        ],
        // ...
    ],
    'CompletedAt' => <DateTime>,
    'ConfigurationLocationUri' => '<string>',
    'ConfigurationName' => '<string>',
    'ConfigurationProfileId' => '<string>',
    'ConfigurationVersion' => '<string>',
    'DeploymentDurationInMinutes' => <integer>,
    'DeploymentNumber' => <integer>,
    'DeploymentStrategyId' => '<string>',
    'Description' => '<string>',
    'EnvironmentId' => '<string>',
    'EventLog' => [
        [
            'ActionInvocations' => [
                [
                    'ActionName' => '<string>',
                    'ErrorCode' => '<string>',
                    'ErrorMessage' => '<string>',
                    'ExtensionIdentifier' => '<string>',
                    'InvocationId' => '<string>',
                    'RoleArn' => '<string>',
                    'Uri' => '<string>',
                ],
                // ...
            ],
            'Description' => '<string>',
            'EventType' => 'PERCENTAGE_UPDATED|ROLLBACK_STARTED|ROLLBACK_COMPLETED|BAKE_TIME_STARTED|DEPLOYMENT_STARTED|DEPLOYMENT_COMPLETED',
            'OccurredAt' => <DateTime>,
            'TriggeredBy' => 'USER|APPCONFIG|CLOUDWATCH_ALARM|INTERNAL_ERROR',
        ],
        // ...
    ],
    'FinalBakeTimeInMinutes' => <integer>,
    'GrowthFactor' => <float>,
    'GrowthType' => 'LINEAR|EXPONENTIAL',
    'KmsKeyArn' => '<string>',
    'KmsKeyIdentifier' => '<string>',
    'PercentageComplete' => <float>,
    'StartedAt' => <DateTime>,
    'State' => 'BAKING|VALIDATING|DEPLOYING|COMPLETE|ROLLING_BACK|ROLLED_BACK',
]

Result Details

Members

ApplicationId

Type: string

The ID of the application that was deployed.

AppliedExtensions

Type: Array of AppliedExtension structures

CompletedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the deployment completed.

ConfigurationLocationUri

Type: string

Information about the source location of the configuration.

ConfigurationName

Type: string

The name of the configuration.

ConfigurationProfileId

Type: string

The ID of the configuration profile that was deployed.

ConfigurationVersion

Type: string

The configuration version that was deployed.

DeploymentDurationInMinutes

Type: int

Total amount of time the deployment lasted.

DeploymentNumber

Type: int

The sequence number of the deployment.

DeploymentStrategyId

Type: string

The ID of the deployment strategy that was deployed.

Description

Type: string

The description of the deployment.

EnvironmentId

Type: string

The ID of the environment that was deployed.

EventLog

Type: Array of DeploymentEvent structures

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

FinalBakeTimeInMinutes

Type: int

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

GrowthFactor

Type: float

The percentage of targets to receive a deployed configuration during each interval.

GrowthType

Type: string

The algorithm used to define how percentage grew over time.

KmsKeyArn

Type: string

KmsKeyIdentifier

Type: string

The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

PercentageComplete

Type: float

The percentage of targets for which the deployment is available.

StartedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the deployment started.

State

Type: string

The state of the deployment.

Errors

ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To stop configuration deployment

The following stop-deployment example stops the deployment of an application configuration to the specified environment.

$result = $client->stopDeployment([
    'ApplicationId' => '339ohji',
    'DeploymentNumber' => 2,
    'EnvironmentId' => '54j1r29',
]);

Result syntax:

[
    'DeploymentDurationInMinutes' => 15,
    'DeploymentNumber' => 2,
    'FinalBakeTimeInMinutes' => 0,
    'GrowthFactor' => 25,
    'PercentageComplete' => 1,
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns metadata to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The ARN of the resource for which to retrieve tags.

Tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The requested resource could not be found.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To tag an application

The following tag-resource example tags an application resource.

$result = $client->tagResource([
    'ResourceArn' => 'arn:aws:appconfig:us-east-1:111122223333:application/339ohji',
    'Tags' => [
        'group1' => '1',
    ],
]);

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes a tag key and value from an AppConfig resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The ARN of the resource for which to remove tags.

TagKeys

Required: Yes
Type: Array of strings

The tag keys to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The requested resource could not be found.
BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To remove a tag from an application

The following untag-resource example removes the group1 tag from the specified application.

$result = $client->untagResource([
    'ResourceArn' => 'arn:aws:appconfig:us-east-1:111122223333:application/339ohji',
    'TagKeys' => [
        'group1',
    ],
]);

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

Updates an application.

Parameter Syntax

$result = $client->updateApplication([
    'ApplicationId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Name' => '<string>',
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

Description

Type: string

A description of the application.

Name

Type: string

The name of the application.

Result Syntax

[
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
]

Result Details

Members

Description

Type: string

The description of the application.

Id

Type: string

The application ID.

Name

Type: string

The application name.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To update an application

The following update-application example updates the name of the specified application.

$result = $client->updateApplication([
    'ApplicationId' => '339ohji',
    'Description' => '',
    'Name' => 'Example-Application',
]);

Result syntax:

[
    'Description' => 'An application used for creating an example.',
    'Id' => '339ohji',
    'Name' => 'Example-Application',
]

UpdateConfigurationProfile

$result = $client->updateConfigurationProfile([/* ... */]);
$promise = $client->updateConfigurationProfileAsync([/* ... */]);

Updates a configuration profile.

Parameter Syntax

$result = $client->updateConfigurationProfile([
    'ApplicationId' => '<string>', // REQUIRED
    'ConfigurationProfileId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Name' => '<string>',
    'RetrievalRoleArn' => '<string>',
    'Validators' => [
        [
            'Content' => '<string>', // REQUIRED
            'Type' => 'JSON_SCHEMA|LAMBDA', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

ConfigurationProfileId

Required: Yes
Type: string

The ID of the configuration profile.

Description

Type: string

A description of the configuration profile.

Name

Type: string

The name of the configuration profile.

RetrievalRoleArn

Type: string

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

Validators

Type: Array of Validator structures

A list of methods for validating the configuration.

Result Syntax

[
    'ApplicationId' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'LocationUri' => '<string>',
    'Name' => '<string>',
    'RetrievalRoleArn' => '<string>',
    'Type' => '<string>',
    'Validators' => [
        [
            'Content' => '<string>',
            'Type' => 'JSON_SCHEMA|LAMBDA',
        ],
        // ...
    ],
]

Result Details

Members

ApplicationId

Type: string

The application ID.

Description

Type: string

The configuration profile description.

Id

Type: string

The configuration profile ID.

LocationUri

Type: string

The URI location of the configuration.

Name

Type: string

The name of the configuration profile.

RetrievalRoleArn

Type: string

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

Type

Type: string

AWS.AppConfig.FeatureFlags

AWS.Freeform

Validators

Type: Array of Validator structures

A list of methods for validating the configuration.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To update a configuration profile

The following update-configuration-profile example updates the description of the specified configuration profile.

$result = $client->updateConfigurationProfile([
    'ApplicationId' => '339ohji',
    'ConfigurationProfileId' => 'ur8hx2f',
    'Description' => 'Configuration profile used for examples.',
]);

Result syntax:

[
    'ApplicationId' => '339ohji',
    'Description' => 'Configuration profile used for examples.',
    'Id' => 'ur8hx2f',
    'LocationUri' => 'ssm-parameter://Example-Parameter',
    'Name' => 'Example-Configuration-Profile',
    'RetrievalRoleArn' => 'arn:aws:iam::111122223333:role/Example-App-Config-Role',
]

UpdateDeploymentStrategy

$result = $client->updateDeploymentStrategy([/* ... */]);
$promise = $client->updateDeploymentStrategyAsync([/* ... */]);

Updates a deployment strategy.

Parameter Syntax

$result = $client->updateDeploymentStrategy([
    'DeploymentDurationInMinutes' => <integer>,
    'DeploymentStrategyId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'FinalBakeTimeInMinutes' => <integer>,
    'GrowthFactor' => <float>,
    'GrowthType' => 'LINEAR|EXPONENTIAL',
]);

Parameter Details

Members

DeploymentDurationInMinutes

Type: int

Total amount of time for a deployment to last.

DeploymentStrategyId

Required: Yes
Type: string

The deployment strategy ID.

Description

Type: string

A description of the deployment strategy.

FinalBakeTimeInMinutes

Type: int

The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

GrowthFactor

Type: float

The percentage of targets to receive a deployed configuration during each interval.

GrowthType

Type: string

The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

2*(2^0)

2*(2^1)

2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

Result Syntax

[
    'DeploymentDurationInMinutes' => <integer>,
    'Description' => '<string>',
    'FinalBakeTimeInMinutes' => <integer>,
    'GrowthFactor' => <float>,
    'GrowthType' => 'LINEAR|EXPONENTIAL',
    'Id' => '<string>',
    'Name' => '<string>',
    'ReplicateTo' => 'NONE|SSM_DOCUMENT',
]

Result Details

Members

DeploymentDurationInMinutes

Type: int

Total amount of time the deployment lasted.

Description

Type: string

The description of the deployment strategy.

FinalBakeTimeInMinutes

Type: int

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

GrowthFactor

Type: float

The percentage of targets that received a deployed configuration during each interval.

GrowthType

Type: string

The algorithm used to define how percentage grew over time.

Id

Type: string

The deployment strategy ID.

Name

Type: string

The name of the deployment strategy.

ReplicateTo

Type: string

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

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To update a deployment strategy

The following update-deployment-strategy example updates final bake time to 20 minutes in the specified deployment strategy. ::

$result = $client->updateDeploymentStrategy([
    'DeploymentStrategyId' => '1225qzk',
    'FinalBakeTimeInMinutes' => 20,
]);

Result syntax:

[
    'DeploymentDurationInMinutes' => 15,
    'FinalBakeTimeInMinutes' => 20,
    'GrowthFactor' => 25,
    'GrowthType' => 'LINEAR',
    'Id' => '1225qzk',
    'Name' => 'Example-Deployment',
    'ReplicateTo' => 'SSM_DOCUMENT',
]

UpdateEnvironment

$result = $client->updateEnvironment([/* ... */]);
$promise = $client->updateEnvironmentAsync([/* ... */]);

Updates an environment.

Parameter Syntax

$result = $client->updateEnvironment([
    'ApplicationId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'EnvironmentId' => '<string>', // REQUIRED
    'Monitors' => [
        [
            'AlarmArn' => '<string>', // REQUIRED
            'AlarmRoleArn' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>',
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

Description

Type: string

A description of the environment.

EnvironmentId

Required: Yes
Type: string

The environment ID.

Monitors

Type: Array of Monitor structures

Amazon CloudWatch alarms to monitor during the deployment process.

Name

Type: string

The name of the environment.

Result Syntax

[
    'ApplicationId' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'Monitors' => [
        [
            'AlarmArn' => '<string>',
            'AlarmRoleArn' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>',
    'State' => 'READY_FOR_DEPLOYMENT|DEPLOYING|ROLLING_BACK|ROLLED_BACK',
]

Result Details

Members

ApplicationId

Type: string

The application ID.

Description

Type: string

The description of the environment.

Id

Type: string

The environment ID.

Monitors

Type: Array of Monitor structures

Amazon CloudWatch alarms monitored during the deployment.

Name

Type: string

The name of the environment.

State

Type: string

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To update an environment

The following update-environment example updates an environment's description.

$result = $client->updateEnvironment([
    'ApplicationId' => '339ohji',
    'Description' => 'An environment for examples.',
    'EnvironmentId' => '54j1r29',
]);

Result syntax:

[
    'ApplicationId' => '339ohji',
    'Description' => 'An environment for examples.',
    'Id' => '54j1r29',
    'Name' => 'Example-Environment',
    'State' => 'ROLLED_BACK',
]

UpdateExtension

$result = $client->updateExtension([/* ... */]);
$promise = $client->updateExtensionAsync([/* ... */]);

Updates an AppConfig extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

Parameter Syntax

$result = $client->updateExtension([
    'Actions' => [
        '<ActionPoint>' => [
            [
                'Description' => '<string>',
                'Name' => '<string>',
                'RoleArn' => '<string>',
                'Uri' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'Description' => '<string>',
    'ExtensionIdentifier' => '<string>', // REQUIRED
    'Parameters' => [
        '<Name>' => [
            'Description' => '<string>',
            'Required' => true || false,
        ],
        // ...
    ],
    'VersionNumber' => <integer>,
]);

Parameter Details

Members

Actions

Type: Associative array of custom strings keys (ActionPoint) to Action structuress

The actions defined in the extension.

Description

Type: string

Information about the extension.

ExtensionIdentifier

Required: Yes
Type: string

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

Parameters

Type: Associative array of custom strings keys (Name) to Parameter structures

One or more parameters for the actions called by the extension.

VersionNumber

Type: int

The extension version number.

Result Syntax

[
    'Actions' => [
        '<ActionPoint>' => [
            [
                'Description' => '<string>',
                'Name' => '<string>',
                'RoleArn' => '<string>',
                'Uri' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'Arn' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Parameters' => [
        '<Name>' => [
            'Description' => '<string>',
            'Required' => true || false,
        ],
        // ...
    ],
    'VersionNumber' => <integer>,
]

Result Details

Members

Actions

Type: Associative array of custom strings keys (ActionPoint) to Action structuress

The actions defined in the extension.

Arn

Type: string

The system-generated Amazon Resource Name (ARN) for the extension.

Description

Type: string

Information about the extension.

Id

Type: string

The system-generated ID of the extension.

Name

Type: string

The extension name.

Parameters

Type: Associative array of custom strings keys (Name) to Parameter structures

VersionNumber

Type: int

The extension version number.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
InternalServerException:
There was an internal failure in the AppConfig service.

UpdateExtensionAssociation

$result = $client->updateExtensionAssociation([/* ... */]);
$promise = $client->updateExtensionAssociationAsync([/* ... */]);

Updates an association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

Parameter Syntax

$result = $client->updateExtensionAssociation([
    'ExtensionAssociationId' => '<string>', // REQUIRED
    'Parameters' => ['<string>', ...],
]);

Parameter Details

Members

ExtensionAssociationId

Required: Yes
Type: string

The system-generated ID for the association.

Parameters

Type: Associative array of custom strings keys (Name) to strings

The parameter names and values defined in the extension.

Result Syntax

[
    'Arn' => '<string>',
    'ExtensionArn' => '<string>',
    'ExtensionVersionNumber' => <integer>,
    'Id' => '<string>',
    'Parameters' => ['<string>', ...],
    'ResourceArn' => '<string>',
]

Result Details

Members

Arn

Type: string

The system-generated Amazon Resource Name (ARN) for the extension.

ExtensionArn

Type: string

The ARN of the extension defined in the association.

ExtensionVersionNumber

Type: int

The version number for the extension defined in the association.

Id

Type: string

The system-generated ID for the association.

Parameters

Type: Associative array of custom strings keys (Name) to strings

The parameter names and values defined in the association.

ResourceArn

Type: string

The ARNs of applications, configuration profiles, or environments defined in the association.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

ValidateConfiguration

$result = $client->validateConfiguration([/* ... */]);
$promise = $client->validateConfigurationAsync([/* ... */]);

Uses the validators in a configuration profile to validate a configuration.

Parameter Syntax

$result = $client->validateConfiguration([
    'ApplicationId' => '<string>', // REQUIRED
    'ConfigurationProfileId' => '<string>', // REQUIRED
    'ConfigurationVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

Required: Yes
Type: string

The application ID.

ConfigurationProfileId

Required: Yes
Type: string

The configuration profile ID.

ConfigurationVersion

Required: Yes
Type: string

The version of the configuration to validate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The requested resource could not be found.
InternalServerException:
There was an internal failure in the AppConfig service.

Examples

Example 1: To validate a configuration

The following validate-configuration example uses the validators in a configuration profile to validate a configuration.

$result = $client->validateConfiguration([
    'ApplicationId' => 'abc1234',
    'ConfigurationProfileId' => 'ur8hx2f',
    'ConfigurationVersion' => '1',
]);

Shapes

Action

Description

An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point such as ON_CREATE_HOSTED_CONFIGURATION, PRE_DEPLOYMENT, or ON_DEPLOYMENT. Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:

PRE_CREATE_HOSTED_CONFIGURATION_VERSION
PRE_START_DEPLOYMENT
ON_DEPLOYMENT_START
ON_DEPLOYMENT_STEP
ON_DEPLOYMENT_BAKING
ON_DEPLOYMENT_COMPLETE
ON_DEPLOYMENT_ROLLED_BACK

Members

Description

Type: string

Information about the action.

Name

Type: string

The action name.

RoleArn

Type: string

An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

Uri

Type: string

The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

ActionInvocation

Description

An extension that was invoked as part of a deployment event.

Members

ActionName

Type: string

The name of the action.

ErrorCode

Type: string

The error code when an extension invocation fails.

ErrorMessage

Type: string

The error message when an extension invocation fails.

ExtensionIdentifier

Type: string

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

InvocationId

Type: string

A system-generated ID for this invocation.

RoleArn

Type: string

An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

Uri

Type: string

AppliedExtension

Description

An extension that was invoked during a deployment.

Members

ExtensionAssociationId

Type: string

The system-generated ID for the association.

ExtensionId

Type: string

The system-generated ID of the extension.

Parameters

Type: Associative array of custom strings keys (Name) to strings

One or more parameters for the actions called by the extension.

VersionNumber

Type: int

The extension version number.

BadRequestDetails

Description

Detailed information about the input that failed to satisfy the constraints specified by a call.

Members

InvalidConfiguration

Type: Array of InvalidConfigurationDetail structures

Detailed information about the bad request exception error when creating a hosted configuration version.

BadRequestException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members

Details

Type: BadRequestDetails structure

Detailed information about the input that failed to satisfy the constraints specified by a call.

Message

Type: string

Reason

Type: string

ConfigurationProfileSummary

Description

A summary of a configuration profile.

Members

ApplicationId

Type: string

The application ID.

Id

Type: string

The ID of the configuration profile.

LocationUri

Type: string

The URI location of the configuration.

Name

Type: string

The name of the configuration profile.

Type

Type: string

AWS.AppConfig.FeatureFlags

AWS.Freeform

ValidatorTypes

Type: Array of strings

The types of validators in the configuration profile.

ConflictException

Description

The request could not be processed because of conflict in the current state of the resource.

Members

Message

Type: string

DeploymentEvent

Description

An object that describes a deployment event.

Members

ActionInvocations

Type: Array of ActionInvocation structures

The list of extensions that were invoked as part of the deployment.

Description

Type: string

A description of the deployment event. Descriptions include, but are not limited to, the user account or the Amazon CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.

EventType

Type: string

The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; and the start or completion of a rollback.

OccurredAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the event occurred.

TriggeredBy

Type: string

The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.

DeploymentSummary

Description

Information about the deployment.

Members

CompletedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Time the deployment completed.

ConfigurationName

Type: string

The name of the configuration.

ConfigurationVersion

Type: string

The version of the configuration.

DeploymentDurationInMinutes

Type: int

Total amount of time the deployment lasted.

DeploymentNumber

Type: int

The sequence number of the deployment.

FinalBakeTimeInMinutes

Type: int

The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

GrowthFactor

Type: float

The percentage of targets to receive a deployed configuration during each interval.

GrowthType

Type: string

The algorithm used to define how percentage grows over time.

PercentageComplete

Type: float

The percentage of targets for which the deployment is available.

StartedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Time the deployment started.

State

Type: string

The state of the deployment.

ExtensionAssociationSummary

Description

Information about an association between an extension and an AppConfig resource such as an application, environment, or configuration profile. Call GetExtensionAssociation to get more information about an association.

Members

ExtensionArn

Type: string

The system-generated Amazon Resource Name (ARN) for the extension.

Id

Type: string

The extension association ID. This ID is used to call other ExtensionAssociation API actions such as GetExtensionAssociation or DeleteExtensionAssociation.

ResourceArn

Type: string

The ARNs of applications, configuration profiles, or environments defined in the association.

ExtensionSummary

Description

Information about an extension. Call GetExtension to get more information about an extension.

Members

Arn

Type: string

The system-generated Amazon Resource Name (ARN) for the extension.

Description

Type: string

Information about the extension.

Id

Type: string

The system-generated ID of the extension.

Name

Type: string

The extension name.

VersionNumber

Type: int

The extension version number.

HostedConfigurationVersionSummary

Description

Information about the configuration.

Members

ApplicationId

Type: string

The application ID.

ConfigurationProfileId

Type: string

The configuration profile ID.

ContentType

Type: string

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

Description

Type: string

A description of the configuration.

VersionLabel

Type: string

A user-defined label for an AppConfig hosted configuration version.

VersionNumber

Type: int

The configuration version.

InternalServerException

Description

There was an internal failure in the AppConfig service.

Members

Message

Type: string

InvalidConfigurationDetail

Description

Detailed information about the bad request exception error when creating a hosted configuration version.

Members

Constraint

Type: string

The invalid or out-of-range validation constraint in your JSON schema that failed validation.

Location

Type: string

Location of the validation constraint in the configuration JSON schema that failed validation.

Reason

Type: string

The reason for an invalid configuration error.

Type

Type: string

The type of error for an invalid configuration.

Value

Type: string

Details about an error with Lambda when a synchronous extension experiences an error during an invocation.

Monitor

Description

Amazon CloudWatch alarms to monitor during the deployment process.

Members

AlarmArn

Required: Yes
Type: string

Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

AlarmRoleArn

Type: string

ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.

Parameter

Description

A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

Members

Description

Type: string

Information about the parameter.

Required

Type: boolean

A parameter value must be specified in the extension association.

PayloadTooLargeException

Description

The configuration size is too large.

Members

Limit

Type: float

Measure

Type: string

Message

Type: string

Size

Type: float

ResourceNotFoundException

Description

The requested resource could not be found.

Members

Message

Type: string

ResourceName

Type: string

ServiceQuotaExceededException

Description

The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.

Members

Message

Type: string

Validator

Description

A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

Members

Content

Required: Yes
Type: string

Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.

Type

Required: Yes
Type: string

AppConfig supports validators of type JSON_SCHEMA and LAMBDA

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon AppConfig 2019-10-09

Operation Summary

Paginators

Operations

CreateApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create an application

CreateConfigurationProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a configuration profile

CreateDeploymentStrategy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a deployment strategy

CreateEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create an environment

CreateExtension

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateExtensionAssociation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateHostedConfigurationVersion

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a hosted configuration version

DeleteApplication

Parameter Syntax

Parameter Details

Members