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

Result Syntax

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

Result Details

Errors

BadRequestException:

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

ServiceQuotaExceededException:

The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:

Applications: 100 max

Deployment strategies: 20 max

Configuration profiles: 100 max per application

Environments: 20 max per application

To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.

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>',
    'KmsKeyIdentifier' => '<string>',
    'LocationUri' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RetrievalRoleArn' => '<string>',
    'Tags' => ['<string>', ...],
    'Type' => '<string>',
    'Validators' => [
        [
            'Content' => '<string>', // REQUIRED
            'Type' => 'JSON_SCHEMA|LAMBDA', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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 one more AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:

Applications: 100 max

Deployment strategies: 20 max

Configuration profiles: 100 max per application

Environments: 20 max per application

To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.

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

Result Syntax

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

Result Details

Errors

InternalServerException:

There was an internal failure in the AppConfig service.

ServiceQuotaExceededException:

The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:

Applications: 100 max

Deployment strategies: 20 max

Configuration profiles: 100 max per application

Environments: 20 max per application

To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.

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

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

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.

ServiceQuotaExceededException:

The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:

Applications: 100 max

Deployment strategies: 20 max

Configuration profiles: 100 max per application

Environments: 20 max per application

To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.

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 an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the Amazon Web Services authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in the Uri field for the new extension version.

• For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the Uri field.

• For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the Uri field.

• For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the Uri field.

For more information about extensions, see Extending workflows 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' => [
        '<ExtensionOrParameterName>' => [
            'Description' => '<string>',
            'Dynamic' => true || false,
            'Required' => true || false,
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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 one more AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:

Applications: 100 max

Deployment strategies: 20 max

Configuration profiles: 100 max per application

Environments: 20 max per application

To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.

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 Extending workflows in the AppConfig User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 one more AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:

Applications: 100 max

Deployment strategies: 20 max

Configuration profiles: 100 max per application

Environments: 20 max per application

To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.

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

Result Syntax

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

Result Details

Errors

BadRequestException:

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

ServiceQuotaExceededException:

The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:

Applications: 100 max

Deployment strategies: 20 max

Configuration profiles: 100 max per application

Environments: 20 max per application

To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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',
    'VersionLabel' => '<string>',
]

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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 Extending workflows in the AppConfig User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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',
            'VersionLabel' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

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

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

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 Extending workflows in the AppConfig User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 Extending workflows in the AppConfig User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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>',
    'DynamicExtensionParameters' => ['<string>', ...],
    'EnvironmentId' => '<string>', // REQUIRED
    'KmsKeyIdentifier' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

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',
    'VersionLabel' => '<string>',
]

Result Details

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

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',
    'VersionLabel' => '<string>',
]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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>',
    'KmsKeyIdentifier' => '<string>',
    'Name' => '<string>',
    'RetrievalRoleArn' => '<string>',
    'Validators' => [
        [
            'Content' => '<string>', // REQUIRED
            'Type' => 'JSON_SCHEMA|LAMBDA', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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 Extending workflows 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' => [
        '<ExtensionOrParameterName>' => [
            'Description' => '<string>',
            'Dynamic' => true || false,
            'Required' => true || false,
        ],
        // ...
    ],
    'VersionNumber' => <integer>,
]);

Parameter Details

Result Syntax

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

Result Details

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 Extending workflows in the AppConfig User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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',
]);