2022/07/13 - Amazon AppConfig - 10 new3 updated api methods
Changes Adding Create, Get, Update, Delete, and List APIs for new two new resources: Extensions and ExtensionAssociations.
Updates an AppConfig extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.
See also: AWS API Documentation
Request Syntax
client.update_extension(
ExtensionIdentifier='string',
Description='string',
Actions={
'string': [
{
'Name': 'string',
'Description': 'string',
'Uri': 'string',
'RoleArn': 'string'
},
]
},
Parameters={
'string': {
'Description': 'string',
'Required': True|False
}
},
VersionNumber=123
)
string
[REQUIRED]
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
string
Information about the extension.
dict
The actions defined in the extension.
(string) --
(list) --
(dict) --
An action defines the tasks 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
Name (string) --
The action name.
Description (string) --
Information about the action.
Uri (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.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
dict
One or more parameters for the actions called by the extension.
(string) --
(dict) --
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.
Description (string) --
Information about the parameter.
Required (boolean) --
A parameter value must be specified in the extension association.
integer
The extension version number.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'VersionNumber': 123,
'Arn': 'string',
'Description': 'string',
'Actions': {
'string': [
{
'Name': 'string',
'Description': 'string',
'Uri': 'string',
'RoleArn': 'string'
},
]
},
'Parameters': {
'string': {
'Description': 'string',
'Required': True|False
}
}
}
Response Structure
(dict) --
Id (string) --
The system-generated ID of the extension.
Name (string) --
The extension name.
VersionNumber (integer) --
The extension version number.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Description (string) --
Information about the extension.
Actions (dict) --
The actions defined in the extension.
(string) --
(list) --
(dict) --
An action defines the tasks 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
Name (string) --
The action name.
Description (string) --
Information about the action.
Uri (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.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
Parameters (dict) --
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.
(string) --
(dict) --
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.
Description (string) --
Information about the parameter.
Required (boolean) --
A parameter value must be specified in the extension association.
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.
See also: AWS API Documentation
Request Syntax
client.list_extension_associations(
ResourceIdentifier='string',
ExtensionIdentifier='string',
ExtensionVersionNumber=123,
MaxResults=123,
NextToken='string'
)
string
The ARN of an application, configuration profile, or environment.
string
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
integer
The version number for the extension defined in the association.
integer
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.
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.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'ExtensionArn': 'string',
'ResourceArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of extension associations. Each item represents an extension association to an application, environment, or configuration profile.
(dict) --
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.
Id (string) --
The extension association ID. This ID is used to call other ExtensionAssociation API actions such as GetExtensionAssociation or DeleteExtensionAssociation.
ExtensionArn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
ResourceArn (string) --
The ARNs of applications, configuration profiles, or environments defined in the association.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Returns information about an AppConfig extension.
See also: AWS API Documentation
Request Syntax
client.get_extension(
ExtensionIdentifier='string',
VersionNumber=123
)
string
[REQUIRED]
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
integer
The extension version number. If no version number was defined, AppConfig uses the highest version.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'VersionNumber': 123,
'Arn': 'string',
'Description': 'string',
'Actions': {
'string': [
{
'Name': 'string',
'Description': 'string',
'Uri': 'string',
'RoleArn': 'string'
},
]
},
'Parameters': {
'string': {
'Description': 'string',
'Required': True|False
}
}
}
Response Structure
(dict) --
Id (string) --
The system-generated ID of the extension.
Name (string) --
The extension name.
VersionNumber (integer) --
The extension version number.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Description (string) --
Information about the extension.
Actions (dict) --
The actions defined in the extension.
(string) --
(list) --
(dict) --
An action defines the tasks 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
Name (string) --
The action name.
Description (string) --
Information about the action.
Uri (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.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
Parameters (dict) --
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.
(string) --
(dict) --
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.
Description (string) --
Information about the parameter.
Required (boolean) --
A parameter value must be specified in the extension association.
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.
See also: AWS API Documentation
Request Syntax
client.create_extension(
Name='string',
Description='string',
Actions={
'string': [
{
'Name': 'string',
'Description': 'string',
'Uri': 'string',
'RoleArn': 'string'
},
]
},
Parameters={
'string': {
'Description': 'string',
'Required': True|False
}
},
Tags={
'string': 'string'
},
LatestVersionNumber=123
)
string
[REQUIRED]
A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.
string
Information about the extension.
dict
[REQUIRED]
The actions defined in the extension.
(string) --
(list) --
(dict) --
An action defines the tasks 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
Name (string) --
The action name.
Description (string) --
Information about the action.
Uri (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.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
dict
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.
(string) --
(dict) --
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.
Description (string) --
Information about the parameter.
Required (boolean) --
A parameter value must be specified in the extension association.
dict
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.
(string) --
(string) --
integer
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.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'VersionNumber': 123,
'Arn': 'string',
'Description': 'string',
'Actions': {
'string': [
{
'Name': 'string',
'Description': 'string',
'Uri': 'string',
'RoleArn': 'string'
},
]
},
'Parameters': {
'string': {
'Description': 'string',
'Required': True|False
}
}
}
Response Structure
(dict) --
Id (string) --
The system-generated ID of the extension.
Name (string) --
The extension name.
VersionNumber (integer) --
The extension version number.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Description (string) --
Information about the extension.
Actions (dict) --
The actions defined in the extension.
(string) --
(list) --
(dict) --
An action defines the tasks 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
Name (string) --
The action name.
Description (string) --
Information about the action.
Uri (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.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
Parameters (dict) --
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.
(string) --
(dict) --
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.
Description (string) --
Information about the parameter.
Required (boolean) --
A parameter value must be specified in the extension association.
Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.
See also: AWS API Documentation
Request Syntax
client.delete_extension(
ExtensionIdentifier='string',
VersionNumber=123
)
string
[REQUIRED]
The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.
integer
A specific version of an extension to delete. If omitted, the highest version is deleted.
None
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.
See also: AWS API Documentation
Request Syntax
client.list_extensions(
MaxResults=123,
NextToken='string',
Name='string'
)
integer
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.
string
A token to start the list. Use this token to get the next set of results.
string
The extension name.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'Name': 'string',
'VersionNumber': 123,
'Arn': 'string',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of available extensions. The list includes Amazon Web Services-authored and user-created extensions.
(dict) --
Information about an extension. Call GetExtension to get more information about an extension.
Id (string) --
The system-generated ID of the extension.
Name (string) --
The extension name.
VersionNumber (integer) --
The extension version number.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Description (string) --
Information about the extension.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Deletes an extension association. This action doesn't delete extensions defined in the association.
See also: AWS API Documentation
Request Syntax
client.delete_extension_association(
ExtensionAssociationId='string'
)
string
[REQUIRED]
The ID of the extension association to delete.
None
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.
See also: AWS API Documentation
Request Syntax
client.create_extension_association(
ExtensionIdentifier='string',
ExtensionVersionNumber=123,
ResourceIdentifier='string',
Parameters={
'string': 'string'
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
integer
The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.
string
[REQUIRED]
The ARN of an application, configuration profile, or environment.
dict
The parameter names and values defined in the extensions. Extension parameters marked Required must be entered for this field.
(string) --
(string) --
dict
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.
(string) --
(string) --
dict
Response Syntax
{
'Id': 'string',
'ExtensionArn': 'string',
'ResourceArn': 'string',
'Arn': 'string',
'Parameters': {
'string': 'string'
},
'ExtensionVersionNumber': 123
}
Response Structure
(dict) --
Id (string) --
The system-generated ID for the association.
ExtensionArn (string) --
The ARN of the extension defined in the association.
ResourceArn (string) --
The ARNs of applications, configuration profiles, or environments defined in the association.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Parameters (dict) --
The parameter names and values defined in the association.
(string) --
(string) --
ExtensionVersionNumber (integer) --
The version number for the extension defined in the association.
Returns information about an AppConfig extension association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.
See also: AWS API Documentation
Request Syntax
client.get_extension_association(
ExtensionAssociationId='string'
)
string
[REQUIRED]
The extension association ID to get.
dict
Response Syntax
{
'Id': 'string',
'ExtensionArn': 'string',
'ResourceArn': 'string',
'Arn': 'string',
'Parameters': {
'string': 'string'
},
'ExtensionVersionNumber': 123
}
Response Structure
(dict) --
Id (string) --
The system-generated ID for the association.
ExtensionArn (string) --
The ARN of the extension defined in the association.
ResourceArn (string) --
The ARNs of applications, configuration profiles, or environments defined in the association.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Parameters (dict) --
The parameter names and values defined in the association.
(string) --
(string) --
ExtensionVersionNumber (integer) --
The version number for the extension defined in the association.
Updates an association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.
See also: AWS API Documentation
Request Syntax
client.update_extension_association(
ExtensionAssociationId='string',
Parameters={
'string': 'string'
}
)
string
[REQUIRED]
The system-generated ID for the association.
dict
The parameter names and values defined in the extension.
(string) --
(string) --
dict
Response Syntax
{
'Id': 'string',
'ExtensionArn': 'string',
'ResourceArn': 'string',
'Arn': 'string',
'Parameters': {
'string': 'string'
},
'ExtensionVersionNumber': 123
}
Response Structure
(dict) --
Id (string) --
The system-generated ID for the association.
ExtensionArn (string) --
The ARN of the extension defined in the association.
ResourceArn (string) --
The ARNs of applications, configuration profiles, or environments defined in the association.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Parameters (dict) --
The parameter names and values defined in the association.
(string) --
(string) --
ExtensionVersionNumber (integer) --
The version number for the extension defined in the association.
{'AppliedExtensions': [{'ExtensionAssociationId': 'string',
'ExtensionId': 'string',
'Parameters': {'string': 'string'},
'VersionNumber': 'integer'}],
'EventLog': {'ActionInvocations': [{'ActionName': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'ExtensionIdentifier': 'string',
'InvocationId': 'string',
'RoleArn': 'string',
'Uri': 'string'}]}}
Retrieves information about a configuration deployment.
See also: AWS API Documentation
Request Syntax
client.get_deployment(
ApplicationId='string',
EnvironmentId='string',
DeploymentNumber=123
)
string
[REQUIRED]
The ID of the application that includes the deployment you want to get.
string
[REQUIRED]
The ID of the environment that includes the deployment you want to get.
integer
[REQUIRED]
The sequence number of the deployment.
dict
Response Syntax
{
'ApplicationId': 'string',
'EnvironmentId': 'string',
'DeploymentStrategyId': 'string',
'ConfigurationProfileId': 'string',
'DeploymentNumber': 123,
'ConfigurationName': 'string',
'ConfigurationLocationUri': 'string',
'ConfigurationVersion': 'string',
'Description': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR'|'EXPONENTIAL',
'GrowthFactor': ...,
'FinalBakeTimeInMinutes': 123,
'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK',
'EventLog': [
{
'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED',
'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
'Description': 'string',
'ActionInvocations': [
{
'ExtensionIdentifier': 'string',
'ActionName': 'string',
'Uri': 'string',
'RoleArn': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'InvocationId': 'string'
},
],
'OccurredAt': datetime(2015, 1, 1)
},
],
'PercentageComplete': ...,
'StartedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1),
'AppliedExtensions': [
{
'ExtensionId': 'string',
'ExtensionAssociationId': 'string',
'VersionNumber': 123,
'Parameters': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
ApplicationId (string) --
The ID of the application that was deployed.
EnvironmentId (string) --
The ID of the environment that was deployed.
DeploymentStrategyId (string) --
The ID of the deployment strategy that was deployed.
ConfigurationProfileId (string) --
The ID of the configuration profile that was deployed.
DeploymentNumber (integer) --
The sequence number of the deployment.
ConfigurationName (string) --
The name of the configuration.
ConfigurationLocationUri (string) --
Information about the source location of the configuration.
ConfigurationVersion (string) --
The configuration version that was deployed.
Description (string) --
The description of the deployment.
DeploymentDurationInMinutes (integer) --
Total amount of time the deployment lasted.
GrowthType (string) --
The algorithm used to define how percentage grew over time.
GrowthFactor (float) --
The percentage of targets to receive a deployed configuration during each interval.
FinalBakeTimeInMinutes (integer) --
The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
State (string) --
The state of the deployment.
EventLog (list) --
A list containing all events related to a deployment. The most recent events are displayed first.
(dict) --
An object that describes a deployment event.
EventType (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.
TriggeredBy (string) --
The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.
Description (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.
ActionInvocations (list) --
The list of extensions that were invoked as part of the deployment.
(dict) --
An extension that was invoked as part of a deployment event.
ExtensionIdentifier (string) --
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
ActionName (string) --
The name of the action.
Uri (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.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
ErrorMessage (string) --
The error message when an extension invocation fails.
ErrorCode (string) --
The error code when an extension invocation fails.
InvocationId (string) --
A system-generated ID for this invocation.
OccurredAt (datetime) --
The date and time the event occurred.
PercentageComplete (float) --
The percentage of targets for which the deployment is available.
StartedAt (datetime) --
The time the deployment started.
CompletedAt (datetime) --
The time the deployment completed.
AppliedExtensions (list) --
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.
(dict) --
An extension that was invoked during a deployment.
ExtensionId (string) --
The system-generated ID of the extension.
ExtensionAssociationId (string) --
The system-generated ID for the association.
VersionNumber (integer) --
The extension version number.
Parameters (dict) --
One or more parameters for the actions called by the extension.
(string) --
(string) --
{'AppliedExtensions': [{'ExtensionAssociationId': 'string',
'ExtensionId': 'string',
'Parameters': {'string': 'string'},
'VersionNumber': 'integer'}],
'EventLog': {'ActionInvocations': [{'ActionName': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'ExtensionIdentifier': 'string',
'InvocationId': 'string',
'RoleArn': 'string',
'Uri': 'string'}]}}
Starts a deployment.
See also: AWS API Documentation
Request Syntax
client.start_deployment(
ApplicationId='string',
EnvironmentId='string',
DeploymentStrategyId='string',
ConfigurationProfileId='string',
ConfigurationVersion='string',
Description='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
The environment ID.
string
[REQUIRED]
The deployment strategy ID.
string
[REQUIRED]
The configuration profile ID.
string
[REQUIRED]
The configuration version to deploy.
string
A description of the deployment.
dict
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.
(string) --
(string) --
dict
Response Syntax
{
'ApplicationId': 'string',
'EnvironmentId': 'string',
'DeploymentStrategyId': 'string',
'ConfigurationProfileId': 'string',
'DeploymentNumber': 123,
'ConfigurationName': 'string',
'ConfigurationLocationUri': 'string',
'ConfigurationVersion': 'string',
'Description': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR'|'EXPONENTIAL',
'GrowthFactor': ...,
'FinalBakeTimeInMinutes': 123,
'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK',
'EventLog': [
{
'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED',
'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
'Description': 'string',
'ActionInvocations': [
{
'ExtensionIdentifier': 'string',
'ActionName': 'string',
'Uri': 'string',
'RoleArn': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'InvocationId': 'string'
},
],
'OccurredAt': datetime(2015, 1, 1)
},
],
'PercentageComplete': ...,
'StartedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1),
'AppliedExtensions': [
{
'ExtensionId': 'string',
'ExtensionAssociationId': 'string',
'VersionNumber': 123,
'Parameters': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
ApplicationId (string) --
The ID of the application that was deployed.
EnvironmentId (string) --
The ID of the environment that was deployed.
DeploymentStrategyId (string) --
The ID of the deployment strategy that was deployed.
ConfigurationProfileId (string) --
The ID of the configuration profile that was deployed.
DeploymentNumber (integer) --
The sequence number of the deployment.
ConfigurationName (string) --
The name of the configuration.
ConfigurationLocationUri (string) --
Information about the source location of the configuration.
ConfigurationVersion (string) --
The configuration version that was deployed.
Description (string) --
The description of the deployment.
DeploymentDurationInMinutes (integer) --
Total amount of time the deployment lasted.
GrowthType (string) --
The algorithm used to define how percentage grew over time.
GrowthFactor (float) --
The percentage of targets to receive a deployed configuration during each interval.
FinalBakeTimeInMinutes (integer) --
The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
State (string) --
The state of the deployment.
EventLog (list) --
A list containing all events related to a deployment. The most recent events are displayed first.
(dict) --
An object that describes a deployment event.
EventType (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.
TriggeredBy (string) --
The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.
Description (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.
ActionInvocations (list) --
The list of extensions that were invoked as part of the deployment.
(dict) --
An extension that was invoked as part of a deployment event.
ExtensionIdentifier (string) --
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
ActionName (string) --
The name of the action.
Uri (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.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
ErrorMessage (string) --
The error message when an extension invocation fails.
ErrorCode (string) --
The error code when an extension invocation fails.
InvocationId (string) --
A system-generated ID for this invocation.
OccurredAt (datetime) --
The date and time the event occurred.
PercentageComplete (float) --
The percentage of targets for which the deployment is available.
StartedAt (datetime) --
The time the deployment started.
CompletedAt (datetime) --
The time the deployment completed.
AppliedExtensions (list) --
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.
(dict) --
An extension that was invoked during a deployment.
ExtensionId (string) --
The system-generated ID of the extension.
ExtensionAssociationId (string) --
The system-generated ID for the association.
VersionNumber (integer) --
The extension version number.
Parameters (dict) --
One or more parameters for the actions called by the extension.
(string) --
(string) --
{'AppliedExtensions': [{'ExtensionAssociationId': 'string',
'ExtensionId': 'string',
'Parameters': {'string': 'string'},
'VersionNumber': 'integer'}],
'EventLog': {'ActionInvocations': [{'ActionName': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'ExtensionIdentifier': 'string',
'InvocationId': 'string',
'RoleArn': 'string',
'Uri': 'string'}]}}
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.
See also: AWS API Documentation
Request Syntax
client.stop_deployment(
ApplicationId='string',
EnvironmentId='string',
DeploymentNumber=123
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
The environment ID.
integer
[REQUIRED]
The sequence number of the deployment.
dict
Response Syntax
{
'ApplicationId': 'string',
'EnvironmentId': 'string',
'DeploymentStrategyId': 'string',
'ConfigurationProfileId': 'string',
'DeploymentNumber': 123,
'ConfigurationName': 'string',
'ConfigurationLocationUri': 'string',
'ConfigurationVersion': 'string',
'Description': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR'|'EXPONENTIAL',
'GrowthFactor': ...,
'FinalBakeTimeInMinutes': 123,
'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK',
'EventLog': [
{
'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED',
'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
'Description': 'string',
'ActionInvocations': [
{
'ExtensionIdentifier': 'string',
'ActionName': 'string',
'Uri': 'string',
'RoleArn': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'InvocationId': 'string'
},
],
'OccurredAt': datetime(2015, 1, 1)
},
],
'PercentageComplete': ...,
'StartedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1),
'AppliedExtensions': [
{
'ExtensionId': 'string',
'ExtensionAssociationId': 'string',
'VersionNumber': 123,
'Parameters': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
ApplicationId (string) --
The ID of the application that was deployed.
EnvironmentId (string) --
The ID of the environment that was deployed.
DeploymentStrategyId (string) --
The ID of the deployment strategy that was deployed.
ConfigurationProfileId (string) --
The ID of the configuration profile that was deployed.
DeploymentNumber (integer) --
The sequence number of the deployment.
ConfigurationName (string) --
The name of the configuration.
ConfigurationLocationUri (string) --
Information about the source location of the configuration.
ConfigurationVersion (string) --
The configuration version that was deployed.
Description (string) --
The description of the deployment.
DeploymentDurationInMinutes (integer) --
Total amount of time the deployment lasted.
GrowthType (string) --
The algorithm used to define how percentage grew over time.
GrowthFactor (float) --
The percentage of targets to receive a deployed configuration during each interval.
FinalBakeTimeInMinutes (integer) --
The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
State (string) --
The state of the deployment.
EventLog (list) --
A list containing all events related to a deployment. The most recent events are displayed first.
(dict) --
An object that describes a deployment event.
EventType (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.
TriggeredBy (string) --
The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.
Description (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.
ActionInvocations (list) --
The list of extensions that were invoked as part of the deployment.
(dict) --
An extension that was invoked as part of a deployment event.
ExtensionIdentifier (string) --
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
ActionName (string) --
The name of the action.
Uri (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.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
ErrorMessage (string) --
The error message when an extension invocation fails.
ErrorCode (string) --
The error code when an extension invocation fails.
InvocationId (string) --
A system-generated ID for this invocation.
OccurredAt (datetime) --
The date and time the event occurred.
PercentageComplete (float) --
The percentage of targets for which the deployment is available.
StartedAt (datetime) --
The time the deployment started.
CompletedAt (datetime) --
The time the deployment completed.
AppliedExtensions (list) --
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.
(dict) --
An extension that was invoked during a deployment.
ExtensionId (string) --
The system-generated ID of the extension.
ExtensionAssociationId (string) --
The system-generated ID for the association.
VersionNumber (integer) --
The extension version number.
Parameters (dict) --
One or more parameters for the actions called by the extension.
(string) --
(string) --