This method works, but is deprecated. Use BatchGetDeploymentTargets instead.
Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises and AWS Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. The maximum number of instances that can be returned is 25.
This method works, but is deprecated. Use BatchGetDeploymentTargets instead.
Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises and Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. The maximum number of instances that can be returned is 25.
Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of targets that can be returned is 25.
The type of targets returned depends on the deployment's compute platform or deployment method:
EC2/On-premises: Information about EC2 instance targets.
AWS Lambda: Information about Lambda functions targets.
Amazon ECS: Information about Amazon ECS service targets.
CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.
Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of targets that can be returned is 25.
The type of targets returned depends on the deployment's compute platform or deployment method:
EC2/On-premises: Information about Amazon EC2 instance targets.
Lambda: Information about Lambda functions targets.
Amazon ECS: Information about Amazon ECS service targets.
CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.
Lists the applications registered with the IAM user or AWS account.
" + "documentation":"Lists the applications registered with the IAM user or Amazon Web Services account.
" }, "ListDeploymentConfigs":{ "name":"ListDeploymentConfigs", @@ -565,7 +567,7 @@ "errors":[ {"shape":"InvalidNextTokenException"} ], - "documentation":"Lists the deployment configurations with the IAM user or AWS account.
" + "documentation":"Lists the deployment configurations with the IAM user or Amazon Web Services account.
" }, "ListDeploymentGroups":{ "name":"ListDeploymentGroups", @@ -581,7 +583,7 @@ {"shape":"ApplicationDoesNotExistException"}, {"shape":"InvalidNextTokenException"} ], - "documentation":"Lists the deployment groups for an application registered with the IAM user or AWS account.
" + "documentation":"Lists the deployment groups for an application registered with the IAM user or Amazon Web Services account.
" }, "ListDeploymentInstances":{ "name":"ListDeploymentInstances", @@ -603,7 +605,7 @@ {"shape":"InvalidTargetFilterNameException"}, {"shape":"InvalidComputePlatformException"} ], - "documentation":" The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or AWS Lambda.
Lists the instance for a deployment associated with the IAM user or AWS account.
", + "documentation":" The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or Lambda.
Lists the instance for a deployment associated with the IAM user or Amazon Web Services account.
", "deprecated":true, "deprecatedMessage":"This operation is deprecated, use ListDeploymentTargets instead." }, @@ -648,7 +650,7 @@ {"shape":"InvalidExternalIdException"}, {"shape":"InvalidInputException"} ], - "documentation":"Lists the deployments in a deployment group for an application registered with the IAM user or AWS account.
" + "documentation":"Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account.
" }, "ListGitHubAccountTokenNames":{ "name":"ListGitHubAccountTokenNames", @@ -712,7 +714,7 @@ {"shape":"InvalidDeploymentIdException"}, {"shape":"UnsupportedActionForDeploymentTypeException"} ], - "documentation":" Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the AWS Lambda or Amazon ECS compute platform. For AWS Lambda deployments, the available lifecycle hooks are BeforeAllowTraffic and AfterAllowTraffic. For Amazon ECS deployments, the available lifecycle hooks are BeforeInstall, AfterInstall, AfterAllowTestTraffic, BeforeAllowTraffic, and AfterAllowTraffic. Lambda validation functions return Succeeded or Failed. For more information, see AppSpec 'hooks' Section for an AWS Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.
Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are BeforeAllowTraffic and AfterAllowTraffic. For Amazon ECS deployments, the available lifecycle hooks are BeforeInstall, AfterInstall, AfterAllowTestTraffic, BeforeAllowTraffic, and AfterAllowTraffic. Lambda validation functions return Succeeded or Failed. For more information, see AppSpec 'hooks' Section for an Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.
Registers with AWS CodeDeploy a revision for the specified application.
" + "documentation":"Registers with CodeDeploy a revision for the specified application.
" }, "RegisterOnPremisesInstance":{ "name":"RegisterOnPremisesInstance", @@ -953,10 +955,10 @@ }, "alarms":{ "shape":"AlarmList", - "documentation":"A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group.
" + "documentation":"A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
" } }, - "documentation":"Information about alarms associated with the deployment group.
" + "documentation":"Information about alarms associated with a deployment or deployment group.
" }, "AlarmList":{ "type":"list", @@ -975,27 +977,27 @@ "members":{ "content":{ "shape":"RawStringContent", - "documentation":"The YAML-formatted or JSON-formatted revision string.
For an AWS Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version.
For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more.
For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as BeforeInstall, during a deployment.
The YAML-formatted or JSON-formatted revision string.
For an Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version.
For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more.
For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as BeforeInstall, during a deployment.
The SHA256 hash value of the revision content.
" } }, - "documentation":" A revision for an AWS Lambda or Amazon ECS deployment that is a YAML-formatted or JSON-formatted string. For AWS Lambda and Amazon ECS deployments, the revision is the same as the AppSpec file. This method replaces the deprecated RawString data type.
A revision for an Lambda or Amazon ECS deployment that is a YAML-formatted or JSON-formatted string. For Lambda and Amazon ECS deployments, the revision is the same as the AppSpec file. This method replaces the deprecated RawString data type.
An application with the specified name with the IAM user or AWS account already exists.
", + "documentation":"An application with the specified name with the IAM user or Amazon Web Services account already exists.
", "exception":true }, "ApplicationDoesNotExistException":{ "type":"structure", "members":{ }, - "documentation":"The application does not exist with the IAM user or AWS account.
", + "documentation":"The application does not exist with the IAM user or Amazon Web Services account.
", "exception":true }, "ApplicationId":{"type":"string"}, @@ -1135,7 +1137,7 @@ "members":{ "applicationName":{ "shape":"ApplicationName", - "documentation":"The name of an AWS CodeDeploy application about which to get revision information.
" + "documentation":"The name of an CodeDeploy application about which to get revision information.
" }, "revisions":{ "shape":"RevisionLocationList", @@ -1192,7 +1194,7 @@ "members":{ "applicationName":{ "shape":"ApplicationName", - "documentation":"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
" + "documentation":"The name of an CodeDeploy application associated with the applicable IAM or Amazon Web Services account.
" }, "deploymentGroupNames":{ "shape":"DeploymentGroupsList", @@ -1256,7 +1258,7 @@ }, "targetIds":{ "shape":"TargetIdList", - "documentation":"The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.
For deployments that use the EC2/On-premises compute platform, the target IDs are EC2 or on-premises instances IDs, and their target type is instanceTarget.
For deployments that use the AWS Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget.
For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <clustername>:<servicename>. Their target type is ecsTarget.
For deployments that are deployed with AWS CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is cloudFormationTarget.
The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.
For deployments that use the EC2/On-premises compute platform, the target IDs are Amazon EC2 or on-premises instances IDs, and their target type is instanceTarget.
For deployments that use the Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget.
For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <clustername>:<servicename>. Their target type is ecsTarget.
For deployments that are deployed with CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is cloudFormationTarget.
A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform.
EC2/On-premises: Each target object is an EC2 or on-premises instance.
AWS Lambda: The target object is a specific version of an AWS Lambda function.
Amazon ECS: The target object is an Amazon ECS service.
CloudFormation: The target object is an AWS CloudFormation blue/green deployment.
A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform.
EC2/On-premises: Each target object is an Amazon EC2 or on-premises instance.
Lambda: The target object is a specific version of an Lambda function.
Amazon ECS: The target object is an Amazon ECS service.
CloudFormation: The target object is an CloudFormation blue/green deployment.
The unique ID of an AWS CloudFormation blue/green deployment.
" + "documentation":"The unique ID of an CloudFormation blue/green deployment.
" }, "targetId":{ "shape":"TargetId", @@ -1382,26 +1384,26 @@ }, "lastUpdatedAt":{ "shape":"Time", - "documentation":"The date and time when the target application was updated by an AWS CloudFormation blue/green deployment.
" + "documentation":"The date and time when the target application was updated by an CloudFormation blue/green deployment.
" }, "lifecycleEvents":{ "shape":"LifecycleEventList", - "documentation":"The lifecycle events of the AWS CloudFormation blue/green deployment to this target application.
" + "documentation":"The lifecycle events of the CloudFormation blue/green deployment to this target application.
" }, "status":{ "shape":"TargetStatus", - "documentation":"The status of an AWS CloudFormation blue/green deployment's target application.
" + "documentation":"The status of an CloudFormation blue/green deployment's target application.
" }, "resourceType":{ "shape":"CloudFormationResourceType", - "documentation":"The resource type for the AWS CloudFormation blue/green deployment.
" + "documentation":"The resource type for the CloudFormation blue/green deployment.
" }, "targetVersionWeight":{ "shape":"TrafficWeight", - "documentation":"The percentage of production traffic that the target version of an AWS CloudFormation blue/green deployment receives.
" + "documentation":"The percentage of production traffic that the target version of an CloudFormation blue/green deployment receives.
" } }, - "documentation":"Information about the target to be updated by an AWS CloudFormation blue/green deployment. This target type is used for all deployments initiated by a CloudFormation stack update.
" + "documentation":"Information about the target to be updated by an CloudFormation blue/green deployment. This target type is used for all deployments initiated by a CloudFormation stack update.
" }, "CommitId":{"type":"string"}, "ComputePlatform":{ @@ -1431,7 +1433,7 @@ "members":{ "applicationName":{ "shape":"ApplicationName", - "documentation":"The name of the application. This name must be unique with the applicable IAM user or AWS account.
" + "documentation":"The name of the application. This name must be unique with the applicable IAM or Amazon Web Services account.
" }, "computePlatform":{ "shape":"ComputePlatform", @@ -1464,7 +1466,7 @@ }, "minimumHealthyHosts":{ "shape":"MinimumHealthyHosts", - "documentation":"The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
The type parameter takes either of the following values:
HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instances and rounds up fractional instances.
The value parameter takes an integer.
For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.
" + "documentation":"The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
The type parameter takes either of the following values:
HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, CodeDeploy converts the percentage to the equivalent number of instances and rounds up fractional instances.
The value parameter takes an integer.
For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.
" }, "trafficRoutingConfig":{ "shape":"TrafficRoutingConfig", @@ -1497,7 +1499,7 @@ "members":{ "applicationName":{ "shape":"ApplicationName", - "documentation":"The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
" + "documentation":"The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
" }, "deploymentGroupName":{ "shape":"DeploymentGroupName", @@ -1505,11 +1507,11 @@ }, "deploymentConfigName":{ "shape":"DeploymentConfigName", - "documentation":"If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group.
For more information about the predefined deployment configurations in AWS CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the AWS CodeDeploy User Guide.
" + "documentation":"If specified, the deployment configuration name can be either one of the predefined configurations provided with CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group.
For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.
" }, "ec2TagFilters":{ "shape":"EC2TagFilterList", - "documentation":"The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.
" + "documentation":"The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.
" }, "onPremisesInstanceTagFilters":{ "shape":"TagFilterList", @@ -1521,11 +1523,11 @@ }, "serviceRoleArn":{ "shape":"Role", - "documentation":"A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
" + "documentation":"A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.
" }, "triggerConfigurations":{ "shape":"TriggerConfigList", - "documentation":"Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an AWS CodeDeploy Event in the AWS CodeDeploy User Guide.
" + "documentation":"Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.
" }, "alarmConfiguration":{ "shape":"AlarmConfiguration", @@ -1537,7 +1539,7 @@ }, "outdatedInstancesStrategy":{ "shape":"OutdatedInstancesStrategy", - "documentation":"Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.
If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.
Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.
If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.
Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.
Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.
The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
" + "documentation":"The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
" }, "deploymentGroupName":{ "shape":"DeploymentGroupName", @@ -1598,7 +1600,7 @@ }, "deploymentConfigName":{ "shape":"DeploymentConfigName", - "documentation":"The name of a deployment configuration associated with the IAM user or AWS account.
If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default.
The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default.
If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.
If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.
During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.
If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.
If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.
If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.
During a deployment, the CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.
If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.
Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
The fileExistsBehavior parameter takes any of the following values:
DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
The fileExistsBehavior parameter takes any of the following values:
DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.
If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.
Represents the input of a CreateDeployment operation.
The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
" + "documentation":"The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
" } }, "documentation":"Represents the input of a DeleteApplication operation.
The name of a deployment configuration associated with the IAM user or AWS account.
" + "documentation":"The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
" } }, "documentation":"Represents the input of a DeleteDeploymentConfig operation.
The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
" + "documentation":"The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
" }, "deploymentGroupName":{ "shape":"DeploymentGroupName", @@ -1682,7 +1688,7 @@ "members":{ "hooksNotCleanedUp":{ "shape":"AutoScalingGroupList", - "documentation":"If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
" + "documentation":"If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
" } }, "documentation":"Represents the output of a DeleteDeploymentGroup operation.
A deployment configuration with the specified name with the IAM user or AWS account already exists.
", + "documentation":"A deployment configuration with the specified name with the IAM user or Amazon Web Services account already exists.
", "exception":true }, "DeploymentConfigDoesNotExistException":{ "type":"structure", "members":{ }, - "documentation":"The deployment configuration does not exist with the IAM user or AWS account.
", + "documentation":"The deployment configuration does not exist with the IAM user or Amazon Web Services account.
", "exception":true }, "DeploymentConfigId":{"type":"string"}, @@ -1782,7 +1788,7 @@ }, "trafficRoutingConfig":{ "shape":"TrafficRoutingConfig", - "documentation":"The configuration that specifies how the deployment traffic is routed. Used for deployments with a Lambda or ECS compute platform only.
" + "documentation":"The configuration that specifies how the deployment traffic is routed. Used for deployments with a Lambda or Amazon ECS compute platform only.
" } }, "documentation":"Information about a deployment configuration.
" @@ -1826,21 +1832,21 @@ "type":"structure", "members":{ }, - "documentation":"The deployment with the IAM user or AWS account does not exist.
", + "documentation":"The deployment with the IAM user or Amazon Web Services account does not exist.
", "exception":true }, "DeploymentGroupAlreadyExistsException":{ "type":"structure", "members":{ }, - "documentation":"A deployment group with the specified name with the IAM user or AWS account already exists.
", + "documentation":"A deployment group with the specified name with the IAM user or Amazon Web Services account already exists.
", "exception":true }, "DeploymentGroupDoesNotExistException":{ "type":"structure", "members":{ }, - "documentation":"The named deployment group with the IAM user or AWS account does not exist.
", + "documentation":"The named deployment group with the IAM user or Amazon Web Services account does not exist.
", "exception":true }, "DeploymentGroupId":{"type":"string"}, @@ -1877,7 +1883,7 @@ }, "serviceRoleArn":{ "shape":"Role", - "documentation":"A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf. For more information, see Create a Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide.
" + "documentation":"A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to Amazon Web Services services on your behalf. For more information, see Create a Service Role for CodeDeploy in the CodeDeploy User Guide.
" }, "targetRevision":{ "shape":"RevisionLocation", @@ -1901,7 +1907,7 @@ }, "outdatedInstancesStrategy":{ "shape":"OutdatedInstancesStrategy", - "documentation":"Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.
If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.
Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.
If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.
Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.
" + "documentation":"Information about groups of tags applied to an Amazon EC2 instance. The deployment group includes only Amazon EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.
" }, "onPremisesTagSet":{ "shape":"OnPremisesTagSet", @@ -2030,11 +2036,11 @@ }, "creator":{ "shape":"DeploymentCreator", - "documentation":"The means by which the deployment was created:
user: A user created the deployment.
autoscaling: Amazon EC2 Auto Scaling created the deployment.
codeDeployRollback: A rollback process created the deployment.
CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated EC2 instances.
The means by which the deployment was created:
user: A user created the deployment.
autoscaling: Amazon EC2 Auto Scaling created the deployment.
codeDeployRollback: A rollback process created the deployment.
CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.
If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.
If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.
During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.
If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.
If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.
If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.
During a deployment, the CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.
If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.
Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.
" }, - "relatedDeployments":{"shape":"RelatedDeployments"} + "relatedDeployments":{"shape":"RelatedDeployments"}, + "overrideAlarmConfiguration":{"shape":"AlarmConfiguration"} }, "documentation":"Information about a deployment.
" }, @@ -2219,7 +2226,7 @@ }, "lambdaTarget":{ "shape":"LambdaTarget", - "documentation":"Information about the target for a deployment that uses the AWS Lambda compute platform.
" + "documentation":"Information about the target for a deployment that uses the Lambda compute platform.
" }, "ecsTarget":{ "shape":"ECSTarget", @@ -2251,7 +2258,7 @@ "type":"structure", "members":{ }, - "documentation":"The maximum number of targets that can be associated with an Amazon ECS or AWS Lambda deployment was exceeded. The target list of both types of deployments must have exactly one item. This exception does not apply to EC2/On-premises deployments.
", + "documentation":"The maximum number of targets that can be associated with an Amazon ECS or Lambda deployment was exceeded. The target list of both types of deployments must have exactly one item. This exception does not apply to EC2/On-premises deployments.
", "exception":true }, "DeploymentTargetType":{ @@ -2321,7 +2328,7 @@ }, "logTail":{ "shape":"LogTail", - "documentation":"The last portion of the diagnostic log.
If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.
" + "documentation":"The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
" } }, "documentation":"Diagnostic information about executable scripts that are part of a deployment.
" @@ -2362,10 +2369,10 @@ "members":{ "ec2TagSetList":{ "shape":"EC2TagSetList", - "documentation":"A list that contains other lists of EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.
" + "documentation":"A list that contains other lists of Amazon EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.
" } }, - "documentation":"Information about groups of EC2 instance tags.
" + "documentation":"Information about groups of Amazon EC2 instance tags.
" }, "EC2TagSetList":{ "type":"list", @@ -2461,14 +2468,14 @@ }, "targetGroup":{ "shape":"TargetGroupInfo", - "documentation":"The target group associated with the task set. The target group is used by AWS CodeDeploy to manage traffic to a task set.
" + "documentation":"The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.
" }, "taskSetLabel":{ "shape":"TargetLabel", "documentation":" A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An AWS CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set.
" + "documentation":"Information about a set of Amazon ECS tasks in an CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set.
" }, "ECSTaskSetCount":{"type":"long"}, "ECSTaskSetIdentifier":{"type":"string"}, @@ -2537,7 +2544,7 @@ "members":{ "code":{ "shape":"ErrorCode", - "documentation":"For more information, see Error Codes for AWS CodeDeploy in the AWS CodeDeploy User Guide.
The error code:
APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.
DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.
HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.
HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.
IAM_ROLE_MISSING: The service role cannot be accessed.
IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.
INTERNAL_ERROR: There was an internal error.
NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.
NO_INSTANCES: No instances were specified, or no instances can be found.
OVER_MAX_INSTANCES: The maximum number of instances was exceeded.
THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more AWS services.
TIMEOUT: The deployment has timed out.
REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.
For more information, see Error Codes for CodeDeploy in the CodeDeploy User Guide.
The error code:
APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.
DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.
HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.
HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.
IAM_ROLE_MISSING: The service role cannot be accessed.
IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.
INTERNAL_ERROR: There was an internal error.
NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.
NO_INSTANCES: No instances were specified, or no instances can be found.
OVER_MAX_INSTANCES: The maximum number of instances was exceeded.
THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more Amazon Web Services services.
TIMEOUT: The deployment has timed out.
REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.
When the revision was first used by AWS CodeDeploy.
" + "documentation":"When the revision was first used by CodeDeploy.
" }, "lastUsedTime":{ "shape":"Timestamp", - "documentation":"When the revision was last used by AWS CodeDeploy.
" + "documentation":"When the revision was last used by CodeDeploy.
" }, "registerTime":{ "shape":"Timestamp", - "documentation":"When the revision was registered with AWS CodeDeploy.
" + "documentation":"When the revision was registered with CodeDeploy.
" } }, "documentation":"Information about an application revision.
" @@ -2593,7 +2600,7 @@ "members":{ "applicationName":{ "shape":"ApplicationName", - "documentation":"The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
" + "documentation":"The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
" } }, "documentation":"Represents the input of a GetApplication operation.
The name of a deployment configuration associated with the IAM user or AWS account.
" + "documentation":"The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
" } }, "documentation":"Represents the input of a GetDeploymentConfig operation.
The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
" + "documentation":"The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
" }, "deploymentGroupName":{ "shape":"DeploymentGroupName", @@ -2699,7 +2706,7 @@ "members":{ "deploymentId":{ "shape":"DeploymentId", - "documentation":"The unique ID of a deployment associated with the IAM user or AWS account.
" + "documentation":"The unique ID of a deployment associated with the IAM user or Amazon Web Services account.
" } }, "documentation":"Represents the input of a GetDeployment operation.
An invalid fileExistsBehavior option was specified to determine how AWS CodeDeploy handles files or directories that already exist in a deployment target location, but weren't part of the previous successful deployment. Valid values include \"DISALLOW,\" \"OVERWRITE,\" and \"RETAIN.\"
", + "documentation":"An invalid fileExistsBehavior option was specified to determine how CodeDeploy handles files or directories that already exist in a deployment target location, but weren't part of the previous successful deployment. Valid values include \"DISALLOW,\" \"OVERWRITE,\" and \"RETAIN.\"
", "exception":true }, "InvalidGitHubAccountTokenException":{ @@ -3253,7 +3260,7 @@ "type":"structure", "members":{ }, - "documentation":"The IgnoreApplicationStopFailures value is invalid. For AWS Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.
The IgnoreApplicationStopFailures value is invalid. For Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.
The UpdateOutdatedInstancesOnly value is invalid. For AWS Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.
The UpdateOutdatedInstancesOnly value is invalid. For Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.
The alias of a Lambda function. For more information, see AWS Lambda Function Aliases in the AWS Lambda Developer Guide.
" + "documentation":"The alias of a Lambda function. For more information, see Lambda Function Aliases in the Lambda Developer Guide.
" }, "currentVersion":{ "shape":"Version", @@ -3505,7 +3512,7 @@ }, "status":{ "shape":"TargetStatus", - "documentation":"The status an AWS Lambda deployment's target Lambda function.
" + "documentation":"The status an Lambda deployment's target Lambda function.
" }, "lastUpdatedAt":{ "shape":"Time", @@ -3520,7 +3527,7 @@ "documentation":" A LambdaFunctionInfo object that describes a target Lambda function.
Information about the target AWS Lambda function during an AWS Lambda deployment.
" + "documentation":"Information about the target Lambda function during an Lambda deployment.
" }, "LastDeploymentInfo":{ "type":"structure", @@ -3619,11 +3626,11 @@ "members":{ "applicationName":{ "shape":"ApplicationName", - "documentation":"The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
" + "documentation":"The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
" }, "sortBy":{ "shape":"ApplicationRevisionSortBy", - "documentation":"The column name to use to sort the list results:
registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.
firstUsedTime: Sort by the time the revisions were first used in a deployment.
lastUsedTime: Sort by the time the revisions were last used in a deployment.
If not specified or set to null, the results are returned in an arbitrary order.
" + "documentation":"The column name to use to sort the list results:
registerTime: Sort by the time the revisions were registered with CodeDeploy.
firstUsedTime: Sort by the time the revisions were first used in a deployment.
lastUsedTime: Sort by the time the revisions were last used in a deployment.
If not specified or set to null, the results are returned in an arbitrary order.
" }, "sortOrder":{ "shape":"SortOrder", @@ -3716,7 +3723,7 @@ "members":{ "applicationName":{ "shape":"ApplicationName", - "documentation":"The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
" + "documentation":"The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
" }, "nextToken":{ "shape":"NextToken", @@ -3815,7 +3822,7 @@ "members":{ "applicationName":{ "shape":"ApplicationName", - "documentation":"The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.
The minimum healthy instance type:
HOST_COUNT: The minimum number of healthy instances as an absolute value.
FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.
In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.
In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful.
For more information, see AWS CodeDeploy Instance Health in the AWS CodeDeploy User Guide.
" + "documentation":"The minimum healthy instance type:
HOST_COUNT: The minimum number of healthy instances as an absolute value.
FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.
In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.
In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful.
For more information, see CodeDeploy Instance Health in the CodeDeploy User Guide.
" }, "value":{ "shape":"MinimumHealthyHostsValue", @@ -4043,7 +4050,7 @@ }, "status":{ "shape":"LifecycleEventStatus", - "documentation":"The result of a Lambda function that validates a deployment lifecycle event. Succeeded and Failed are the only valid values for status.
The result of a Lambda function that validates a deployment lifecycle event. The values listed in Valid Values are valid for lifecycle statuses in general; however, only Succeeded and Failed can be passed successfully in your API call.
The SHA256 hash value of the revision content.
" } }, - "documentation":"A revision for an AWS Lambda deployment that is a YAML-formatted or JSON-formatted string. For AWS Lambda deployments, the revision is the same as the AppSpec file.
", + "documentation":"A revision for an Lambda deployment that is a YAML-formatted or JSON-formatted string. For Lambda deployments, the revision is the same as the AppSpec file.
", "deprecated":true, "deprecatedMessage":"RawString and String revision type are deprecated, use AppSpecContent type instead." }, @@ -4083,7 +4090,7 @@ "members":{ "applicationName":{ "shape":"ApplicationName", - "documentation":"The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
" + "documentation":"The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
" }, "description":{ "shape":"Description", @@ -4173,7 +4180,7 @@ "type":"structure", "members":{ }, - "documentation":"The named revision does not exist with the IAM user or AWS account.
", + "documentation":"The named revision does not exist with the IAM user or Amazon Web Services account.
", "exception":true }, "RevisionInfo":{ @@ -4199,7 +4206,7 @@ "members":{ "revisionType":{ "shape":"RevisionLocationType", - "documentation":"The type of application revision:
S3: An application revision stored in Amazon S3.
GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).
String: A YAML-formatted or JSON-formatted string (AWS Lambda deployments only).
AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.
The type of application revision:
S3: An application revision stored in Amazon S3.
GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).
String: A YAML-formatted or JSON-formatted string (Lambda deployments only).
AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.
Information about the location of an AWS Lambda deployment revision stored as a RawString.
" + "documentation":"Information about the location of an Lambda deployment revision stored as a RawString.
" }, "appSpecContent":{ "shape":"AppSpecContent", - "documentation":"The content of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.
" + "documentation":"The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.
" } }, "documentation":"Information about the location of an application revision.
" @@ -4510,7 +4517,7 @@ }, "ec2TagSet":{ "shape":"EC2TagSet", - "documentation":"Information about the groups of EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as tagFilters.
Information about the groups of Amazon EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as tagFilters.
Information about the instances to be used in the replacement environment in a blue/green deployment.
" @@ -4554,7 +4561,7 @@ "documentation":"The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.
A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.
" + "documentation":"A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.
" }, "TimeBasedLinear":{ "type":"structure", @@ -4608,10 +4615,10 @@ }, "timeBasedLinear":{ "shape":"TimeBasedLinear", - "documentation":"A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.
" + "documentation":"A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file.
" } }, - "documentation":"The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an AWS Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.
" + "documentation":"The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.
" }, "TrafficRoutingType":{ "type":"string", @@ -4748,7 +4755,7 @@ }, "autoScalingGroups":{ "shape":"AutoScalingGroupNameList", - "documentation":"The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names.
" + "documentation":"The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.
To keep the Auto Scaling groups, enter their names or do not specify this parameter.
To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error \"Heartbeat Timeout\" in the CodeDeploy User Guide.
Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the AWS CodeDeploy User Guide.
" + "documentation":"Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.
" }, "alarmConfiguration":{ "shape":"AlarmConfiguration", @@ -4768,7 +4775,7 @@ }, "outdatedInstancesStrategy":{ "shape":"OutdatedInstancesStrategy", - "documentation":"Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.
If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.
Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.
If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.
Information about groups of tags applied to on-premises instances. The deployment group includes only EC2 instances identified by all the tag groups.
" + "documentation":"Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.
" }, "ecsServices":{ "shape":"ECSServiceList", @@ -4802,7 +4809,7 @@ "members":{ "hooksNotCleanedUp":{ "shape":"AutoScalingGroupList", - "documentation":"If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account.
" + "documentation":"If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon Web Services account. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon Web Services account.
" } }, "documentation":"Represents the output of an UpdateDeploymentGroup operation.
AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless AWS Lambda functions, or applications in an Amazon ECS service.
You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.
AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.
AWS CodeDeploy Components
Use the information in this guide to help you work with the following AWS CodeDeploy components:
Application: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.
Deployment group: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.
Deployment configuration: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.
Deployment: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances.
Application revisions: For an AWS Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.
This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for AWS CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.
AWS CodeDeploy Information Resources
CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.
You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.
CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.
CodeDeploy Components
Use the information in this guide to help you work with the following CodeDeploy components:
Application: A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.
Deployment group: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.
Deployment configuration: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.
Deployment: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances.
Application revisions: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.
This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.
CodeDeploy Information Resources
The Amazon Web Services tags used to filter the resource collection that is used for a cost estimate.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
The Amazon Web Services tags used to filter the resource collection that is used for a cost estimate.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
Information about a filter used to specify which Amazon Web Services resources are analyzed to create a monthly DevOps Guru cost estimate. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
" @@ -1338,7 +1338,7 @@ }, "Tags":{ "shape":"TagHealths", - "documentation":"Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
The Amazon Web Services tags that are used by resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
The Amazon Web Services tags that are used by resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
Information about a notification channel configured in DevOps Guru to send notifications when insights are created.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.
" + }, + "Filters":{ + "shape":"NotificationFilterConfig", + "documentation":" The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. If you do not provide filter configurations, the default configurations are to receive notifications for all message types of High or Medium severity.
Information about notification channels you have configured with DevOps Guru. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).
" @@ -2367,6 +2371,36 @@ "min":36, "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, + "NotificationFilterConfig":{ + "type":"structure", + "members":{ + "Severities":{ + "shape":"InsightSeverities", + "documentation":" The severity levels that you want to receive notifications for. For example, you can choose to receive notifications only for insights with HIGH and MEDIUM severity levels. For more information, see Understanding insight severities.
The events that you want to receive notifications for. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created.
" + } + }, + "documentation":"The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. You can choose to specify which events or message types to receive notifications for. You can also choose to specify which severity levels to receive notifications for.
" + }, + "NotificationMessageType":{ + "type":"string", + "enum":[ + "NEW_INSIGHT", + "CLOSED_INSIGHT", + "NEW_ASSOCIATION", + "SEVERITY_UPGRADED", + "NEW_RECOMMENDATION" + ] + }, + "NotificationMessageTypes":{ + "type":"list", + "member":{"shape":"NotificationMessageType"}, + "max":5, + "min":0 + }, "NumMetricsAnalyzed":{"type":"integer"}, "NumOpenProactiveInsights":{"type":"integer"}, "NumOpenReactiveInsights":{"type":"integer"}, @@ -3238,7 +3272,7 @@ }, "Tags":{ "shape":"TagCollections", - "documentation":"The Amazon Web Services tags that are used by resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
The Amazon Web Services tags that are used by resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
A collection of Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
" @@ -3252,7 +3286,7 @@ }, "Tags":{ "shape":"TagCollectionFilters", - "documentation":"The Amazon Web Services tags used to filter the resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
The Amazon Web Services tags used to filter the resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
Information about a filter used to specify which Amazon Web Services resources are analyzed for anomalous behavior by DevOps Guru.
" @@ -3656,14 +3690,14 @@ "members":{ "AppBoundaryKey":{ "shape":"AppBoundaryKey", - "documentation":"An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
The values in an Amazon Web Services tag collection.
The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.
A collection of Amazon Web Services stags.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
A collection of Amazon Web Services tags.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
The updated Amazon Web Services tags used to filter the resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
The updated Amazon Web Services tags used to filter the resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
Contains information used to update a collection of Amazon Web Services resources.
" @@ -3899,7 +3933,7 @@ "members":{ "AppBoundaryKey":{ "shape":"AppBoundaryKey", - "documentation":"An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
" + "documentation":"Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
For more information about deleting a policy, see Delete lifecycle policies.
" }, "GetLifecyclePolicies":{ "name":"GetLifecyclePolicies", @@ -133,7 +133,7 @@ {"shape":"InternalServerException"}, {"shape":"LimitExceededException"} ], - "documentation":"Updates the specified lifecycle policy.
" + "documentation":"Updates the specified lifecycle policy.
For more information about updating a policy, see Modify lifecycle policies.
" } }, "shapes":{ @@ -167,6 +167,28 @@ "min":0, "pattern":"[0-9A-Za-z _-]+" }, + "ArchiveRetainRule":{ + "type":"structure", + "required":["RetentionArchiveTier"], + "members":{ + "RetentionArchiveTier":{ + "shape":"RetentionArchiveTier", + "documentation":"Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots.
" + } + }, + "documentation":"[Snapshot policies only] Specifies information about the archive storage tier retention period.
" + }, + "ArchiveRule":{ + "type":"structure", + "required":["RetainRule"], + "members":{ + "RetainRule":{ + "shape":"ArchiveRetainRule", + "documentation":"Information about the retention period for the snapshot archiving rule.
" + } + }, + "documentation":"[Snapshot policies only] Specifies a snapshot archiving rule for a schedule.
" + }, "AvailabilityZone":{ "type":"string", "max":16, @@ -255,14 +277,14 @@ }, "Times":{ "shape":"TimesList", - "documentation":"The time, in UTC, to start the operation. The supported format is hh:mm.
The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon DLM selects a time within the next 24 hours.
" + "documentation":"The time, in UTC, to start the operation. The supported format is hh:mm.
The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.
" }, "CronExpression":{ "shape":"CronExpression", "documentation":"The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see Cron expressions in the Amazon CloudWatch User Guide.
" } }, - "documentation":"[Snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.
You must specify either a Cron expression or an interval, interval unit, and start time. You cannot specify both.
[Snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.
You must specify either CronExpression, or Interval, IntervalUnit, and Times.
If you need to specify an ArchiveRule for the schedule, then you must specify a creation frequency of at least 28 days.
The Availability Zones in which to enable fast snapshot restore.
" } }, - "documentation":"[Snapshot policies only] Specifies a rule for enabling fast snapshot restore for snapshots created by snaspshot policies. You can enable fast snapshot restore based on either a count or a time interval.
" + "documentation":"[Snapshot policies only] Specifies a rule for enabling fast snapshot restore for snapshots created by snapshot policies. You can enable fast snapshot restore based on either a count or a time interval.
" }, "GetLifecyclePoliciesRequest":{ "type":"structure", @@ -754,7 +776,7 @@ "documentation":"[Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
" } }, - "documentation":"[Snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The set of valid parameters depends on the combination of policy type and target resource type.
If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon DLM will not create any snapshots for the affected instance, and it will emit a SnapshotsCreateFailed Amazon CloudWatch metric. For more information, see Monitor your policies using Amazon CloudWatch.
[Snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The set of valid parameters depends on the combination of policy type and target resource type.
If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create any snapshots for the affected instance, and it will emit a SnapshotsCreateFailed Amazon CloudWatch metric. For more information, see Monitor your policies using Amazon CloudWatch.
The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
" + }, + "IntervalUnit":{ + "shape":"RetentionIntervalUnitValues", + "documentation":"The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
[Snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies, or for AMIs created by AMI policies.
For snapshot policies that have an ArchiveRule, this retention rule applies to standard tier retention. When the retention threshold is met, snapshots are moved from the standard to the archive tier.
For snapshot policies that do not have an ArchiveRule, snapshots are permanently deleted when this retention threshold is met.
You can retain snapshots based on either a count or a time interval.
Count-based retention
You must specify Count. If you specify an ArchiveRule for the schedule, then you can specify a retention count of 0 to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention count of 1 or more.
Age-based retention
You must specify Interval and IntervalUnit. If you specify an ArchiveRule for the schedule, then you can specify a retention interval of 0 days to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention interval of 1 day or more.
The number of snapshots to retain for each volume, up to a maximum of 1000.
" + "documentation":"The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.
" }, "Interval":{ "shape":"Interval", - "documentation":"The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
" + "documentation":"Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
" }, "IntervalUnit":{ "shape":"RetentionIntervalUnitValues", - "documentation":"The unit of time for time-based retention.
" + "documentation":"The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
[Snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies or for AMIs created by AMI policies. You can retain snapshots based on either a count or a time interval.
You must specify either Count, or Interval and IntervalUnit.
" + "documentation":"[Snapshot policies only] Describes the retention rule for archived snapshots. Once the archive retention threshold is met, the snapshots are permanently deleted from the archive tier.
The archive retention rule must retain snapshots in the archive tier for a minimum of 90 days.
For count-based schedules, you must specify Count. For age-based schedules, you must specify Interval and IntervalUnit.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
" }, "RetentionIntervalUnitValues":{ "type":"string", @@ -937,6 +977,10 @@ "DeprecateRule":{ "shape":"DeprecateRule", "documentation":"[AMI policies only] The AMI deprecation rule for the schedule.
" + }, + "ArchiveRule":{ + "shape":"ArchiveRule", + "documentation":"[Snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
" } }, "documentation":"[Snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.
" @@ -996,6 +1040,15 @@ "max":50, "min":0 }, + "StandardTierRetainRuleCount":{ + "type":"integer", + "max":1000, + "min":0 + }, + "StandardTierRetainRuleInterval":{ + "type":"integer", + "min":0 + }, "StatusMessage":{ "type":"string", "max":500, @@ -1197,5 +1250,5 @@ "min":0 } }, - "documentation":"With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create lifecycle policies, which are used to automate operations on the specified resources.
Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see Automating the Amazon EBS Snapshot Lifecycle in the Amazon EC2 User Guide.
" + "documentation":"With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create lifecycle policies, which are used to automate operations on the specified resources.
Amazon Data Lifecycle Manager supports Amazon EBS volumes and snapshots. For information about using Amazon Data Lifecycle Manager with Amazon EBS, see Amazon Data Lifecycle Manager in the Amazon EC2 User Guide.
" } diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index e40ae5328c..6c052bed15 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -2827,6 +2827,28 @@ "us-west-2" : { } } }, + "codestar-notifications" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, "cognito-identity" : { "endpoints" : { "ap-northeast-1" : { }, @@ -7604,6 +7626,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, diff --git a/botocore/data/sagemaker-runtime/2017-05-13/service-2.json b/botocore/data/sagemaker-runtime/2017-05-13/service-2.json index 030da597d3..3570ca17d9 100644 --- a/botocore/data/sagemaker-runtime/2017-05-13/service-2.json +++ b/botocore/data/sagemaker-runtime/2017-05-13/service-2.json @@ -59,6 +59,12 @@ "pattern":"\\p{ASCII}*", "sensitive":true }, + "EnableExplanationsHeader":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*" + }, "EndpointName":{ "type":"string", "max":63, @@ -227,6 +233,12 @@ "documentation":"If you provide a value, it is added to the captured data when you enable data capture on the endpoint. For information about data capture, see Capture Data.
", "location":"header", "locationName":"X-Amzn-SageMaker-Inference-Id" + }, + "EnableExplanations":{ + "shape":"EnableExplanationsHeader", + "documentation":"An optional JMESPath expression used to override the EnableExplanations parameter of the ClarifyExplainerConfig API. See the EnableExplanations section in the developer guide for more information.
Includes the inference provided by the model.
For information about the format of the response body, see Common Data Formats-Inference.
" + "documentation":"Includes the inference provided by the model.
For information about the format of the response body, see Common Data Formats-Inference.
If the explainer is activated, the body includes the explanations provided by the model. For more information, see the Response section under Invoke the Endpoint in the Developer Guide.
" }, "ContentType":{ "shape":"Header", diff --git a/botocore/data/sagemaker/2017-07-24/service-2.json b/botocore/data/sagemaker/2017-07-24/service-2.json index dd1c70890a..2169e8a98b 100644 --- a/botocore/data/sagemaker/2017-07-24/service-2.json +++ b/botocore/data/sagemaker/2017-07-24/service-2.json @@ -5244,6 +5244,307 @@ }, "documentation":"The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.
" }, + "ClarifyContentTemplate":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*" + }, + "ClarifyEnableExplanations":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*" + }, + "ClarifyExplainerConfig":{ + "type":"structure", + "required":["ShapConfig"], + "members":{ + "EnableExplanations":{ + "shape":"ClarifyEnableExplanations", + "documentation":"A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See EnableExplanations for additional information.
The inference configuration parameter for the model container.
" + }, + "ShapConfig":{ + "shape":"ClarifyShapConfig", + "documentation":"The configuration for SHAP analysis.
" + } + }, + "documentation":"The configuration parameters for the SageMaker Clarify explainer.
" + }, + "ClarifyFeatureHeaders":{ + "type":"list", + "member":{"shape":"ClarifyHeader"}, + "max":256, + "min":1 + }, + "ClarifyFeatureType":{ + "type":"string", + "enum":[ + "numerical", + "categorical", + "text" + ] + }, + "ClarifyFeatureTypes":{ + "type":"list", + "member":{"shape":"ClarifyFeatureType"}, + "max":256, + "min":1 + }, + "ClarifyFeaturesAttribute":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*" + }, + "ClarifyHeader":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*" + }, + "ClarifyInferenceConfig":{ + "type":"structure", + "members":{ + "FeaturesAttribute":{ + "shape":"ClarifyFeaturesAttribute", + "documentation":"Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if FeaturesAttribute is the JMESPath expression 'myfeatures', it extracts a list of features [1,2,3] from request data '{\"myfeatures\":[1,2,3}'.
A template string used to format a JSON record into an acceptable model container input. For example, a ContentTemplate string '{\"myfeatures\":$features}' will format a list of features [1,2,3] into the record string '{\"myfeatures\":[1,2,3]}'. Required only when the model container input is in JSON Lines format.
The maximum number of records in a request that the model container can process when querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If MaxRecordCount is 1, the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container's capacity at runtime.
The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to 6 MB.
A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.
Example for a single class model: If the model container output consists of a string-formatted prediction label followed by its probability: '1,0.6', set ProbabilityIndex to 1 to select the probability value 0.6.
Example for a multiclass model: If the model container output consists of a string-formatted prediction label followed by its probability: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set ProbabilityIndex to 1 to select the probability values [0.1,0.6,0.3].
A zero-based index used to extract a label header or list of label headers from model container output in CSV format.
Example for a multiclass model: If the model container output consists of label headers followed by probabilities: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set LabelIndex to 0 to select the label headers ['cat','dog','fish'].
A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.
Example: If the model container output of a single request is '{\"predicted_label\":1,\"probability\":0.6}', then set ProbabilityAttribute to 'probability'.
A JMESPath expression used to locate the list of label headers in the model container output.
Example: If the model container output of a batch request is '{\"labels\":[\"cat\",\"dog\",\"fish\"],\"probability\":[0.6,0.3,0.1]}', then set LabelAttribute to 'labels' to extract the list of label headers [\"cat\",\"dog\",\"fish\"]
For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the InvokeEndpoint API. See the response section under Invoke the endpoint in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.
The names of the features. If provided, these are included in the endpoint response payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint in the Developer Guide for more information.
A list of data types of the features (optional). Applicable only to NLP explainability. If provided, FeatureTypes must have at least one 'text' string (for example, ['text']). If FeatureTypes is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the response section under Invoke the endpoint in the Developer Guide for more information.
The inference configuration parameter for the model container.
" + }, + "ClarifyLabelAttribute":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*" + }, + "ClarifyLabelHeaders":{ + "type":"list", + "member":{"shape":"ClarifyHeader"}, + "max":16, + "min":1 + }, + "ClarifyLabelIndex":{ + "type":"integer", + "min":0 + }, + "ClarifyMaxPayloadInMB":{ + "type":"integer", + "max":25, + "min":1 + }, + "ClarifyMaxRecordCount":{ + "type":"integer", + "min":1 + }, + "ClarifyMimeType":{ + "type":"string", + "max":255, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*" + }, + "ClarifyProbabilityAttribute":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*" + }, + "ClarifyProbabilityIndex":{ + "type":"integer", + "min":0 + }, + "ClarifyShapBaseline":{ + "type":"string", + "max":4096, + "min":1, + "pattern":"[\\s\\S]+" + }, + "ClarifyShapBaselineConfig":{ + "type":"structure", + "members":{ + "MimeType":{ + "shape":"ClarifyMimeType", + "documentation":"The MIME type of the baseline data. Choose from 'text/csv' or 'application/jsonlines'. Defaults to 'text/csv'.
The inline SHAP baseline data in string format. ShapBaseline can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the Granularity of the TextConfig parameter. The size limit for ShapBasline is 4 KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB of baseline data.
The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ShapBaselineUri should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.
The configuration for the SHAP baseline (also called the background or reference dataset) of the Kernal SHAP algorithm.
The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.
ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.
The configuration for the SHAP baseline of the Kernal SHAP algorithm.
" + }, + "NumberOfSamples":{ + "shape":"ClarifyShapNumberOfSamples", + "documentation":"The number of samples to be used for analysis by the Kernal SHAP algorithm.
The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.
A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. Defaults to false.
" + }, + "Seed":{ + "shape":"ClarifyShapSeed", + "documentation":"The starting value used to initialize the random number generator in the explainer. Provide a value for this parameter to obtain a deterministic SHAP result.
" + }, + "TextConfig":{ + "shape":"ClarifyTextConfig", + "documentation":"A parameter that indicates if text features are treated as text and explanations are provided for individual units of text. Required for natural language processing (NLP) explainability only.
" + } + }, + "documentation":"The configuration for SHAP analysis using SageMaker Clarify Explainer.
" + }, + "ClarifyShapNumberOfSamples":{ + "type":"integer", + "min":1 + }, + "ClarifyShapSeed":{"type":"integer"}, + "ClarifyShapUseLogit":{"type":"boolean"}, + "ClarifyTextConfig":{ + "type":"structure", + "required":[ + "Language", + "Granularity" + ], + "members":{ + "Language":{ + "shape":"ClarifyTextLanguage", + "documentation":"Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.
For a mix of multiple languages, use code 'xx'.
The unit of granularity for the analysis of text features. For example, if the unit is 'token', then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.
A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text. Required only for natural language processing (NLP) explainability.
" + }, + "ClarifyTextGranularity":{ + "type":"string", + "enum":[ + "token", + "sentence", + "paragraph" + ] + }, + "ClarifyTextLanguage":{ + "type":"string", + "enum":[ + "af", + "sq", + "ar", + "hy", + "eu", + "bn", + "bg", + "ca", + "zh", + "hr", + "cs", + "da", + "nl", + "en", + "et", + "fi", + "fr", + "de", + "el", + "gu", + "he", + "hi", + "hu", + "is", + "id", + "ga", + "it", + "kn", + "ky", + "lv", + "lt", + "lb", + "mk", + "ml", + "mr", + "ne", + "nb", + "fa", + "pl", + "pt", + "ro", + "ru", + "sa", + "sr", + "tn", + "si", + "sk", + "sl", + "es", + "sv", + "tl", + "ta", + "tt", + "te", + "tr", + "uk", + "ur", + "yo", + "lij", + "xx" + ] + }, "ClientId":{ "type":"string", "max":1024, @@ -6452,6 +6753,10 @@ "AsyncInferenceConfig":{ "shape":"AsyncInferenceConfig", "documentation":"Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
" + }, + "ExplainerConfig":{ + "shape":"ExplainerConfig", + "documentation":"A member of CreateEndpointConfig that enables explainers.
Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
The configuration parameters for an explainer.
" } } }, @@ -10215,6 +10524,10 @@ "PendingDeploymentSummary":{ "shape":"PendingDeploymentSummary", "documentation":"Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.
" + }, + "ExplainerConfig":{ + "shape":"ExplainerConfig", + "documentation":"The configuration parameters for an explainer.
" } } }, @@ -13906,6 +14219,16 @@ "type":"string", "min":1 }, + "ExplainerConfig":{ + "type":"structure", + "members":{ + "ClarifyExplainerConfig":{ + "shape":"ClarifyExplainerConfig", + "documentation":"A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.
A parameter to activate explainers.
" + }, "FailStepMetadata":{ "type":"structure", "members":{ diff --git a/botocore/data/sso-oidc/2019-06-10/service-2.json b/botocore/data/sso-oidc/2019-06-10/service-2.json index f6972ff871..68e11e1755 100644 --- a/botocore/data/sso-oidc/2019-06-10/service-2.json +++ b/botocore/data/sso-oidc/2019-06-10/service-2.json @@ -51,7 +51,7 @@ {"shape":"InvalidClientMetadataException"}, {"shape":"InternalServerException"} ], - "documentation":"Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.
", + "documentation":"Registers a client with IAM Identity Center. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.
", "authtype":"none" }, "StartDeviceAuthorization":{ @@ -118,7 +118,7 @@ }, "grantType":{ "shape":"GrantType", - "documentation":"Supports grant types for authorization code, refresh token, and device code request.
" + "documentation":"Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:
urn:ietf:params:oauth:grant-type:device_code
For information about how to obtain the device code, see the StartDeviceAuthorization topic.
" }, "deviceCode":{ "shape":"DeviceCode", @@ -130,7 +130,7 @@ }, "refreshToken":{ "shape":"RefreshToken", - "documentation":"The token used to obtain an access token in the event that the access token is invalid or expired. This token is not issued by the service.
" + "documentation":"Currently, refreshToken is not yet implemented and is not supported. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
The token used to obtain an access token in the event that the access token is invalid or expired.
" }, "scope":{ "shape":"Scopes", @@ -147,7 +147,7 @@ "members":{ "accessToken":{ "shape":"AccessToken", - "documentation":"An opaque token to access AWS SSO resources assigned to a user.
" + "documentation":"An opaque token to access IAM Identity Center resources assigned to a user.
" }, "tokenType":{ "shape":"TokenType", @@ -159,11 +159,11 @@ }, "refreshToken":{ "shape":"RefreshToken", - "documentation":"A token that, if present, can be used to refresh a previously issued access token that might have expired.
" + "documentation":"Currently, refreshToken is not yet implemented and is not supported. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
A token that, if present, can be used to refresh a previously issued access token that might have expired.
" }, "idToken":{ "shape":"IdToken", - "documentation":"The identifier of the user that associated with the access token, if present.
" + "documentation":"Currently, idToken is not yet implemented and is not supported. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
The identifier of the user that associated with the access token, if present.
" } } }, @@ -322,7 +322,7 @@ "members":{ "clientId":{ "shape":"ClientId", - "documentation":"The unique identifier string for the client that is registered with AWS SSO. This value should come from the persisted result of the RegisterClient API operation.
" + "documentation":"The unique identifier string for the client that is registered with IAM Identity Center. This value should come from the persisted result of the RegisterClient API operation.
" }, "clientSecret":{ "shape":"ClientSecret", @@ -330,7 +330,7 @@ }, "startUrl":{ "shape":"URI", - "documentation":"The URL for the AWS SSO user portal. For more information, see Using the User Portal in the AWS Single Sign-On User Guide.
" + "documentation":"The URL for the AWS access portal. For more information, see Using the AWS access portal in the IAM Identity Center User Guide.
" } } }, @@ -387,5 +387,5 @@ }, "UserCode":{"type":"string"} }, - "documentation":"AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of the device authorization grant standard (https://tools.ietf.org/html/rfc8628).
For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.
This API reference guide describes the AWS SSO OIDC operations that you can call programatically and includes detailed information on data types and errors.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
AWS IAM Identity Center (successor to AWS Single Sign-On) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with IAM Identity Center. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with IAM Identity Center.
Although AWS Single Sign-On was renamed, the sso and identitystore API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see IAM Identity Center rename.
Considerations for Using This Guide
Before you begin using this guide, we recommend that you first review the following important information about how the IAM Identity Center OIDC service works.
The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device Authorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single sign-on authentication with the AWS CLI. Support for other OIDC flows frequently needed for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in future releases.
The service emits only OIDC access tokens, such that obtaining a new token (For example, token refresh) requires explicit user re-authentication.
The access tokens provided by this service grant access to all AWS account entitlements assigned to an IAM Identity Center user, not just a particular application.
The documentation in this guide does not describe the mechanism to convert the access token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service endpoints. For more information, see GetRoleCredentials in the IAM Identity Center Portal API Reference Guide.
For general information about IAM Identity Center, see What is IAM Identity Center? in the IAM Identity Center User Guide.
" } diff --git a/docs/source/conf.py b/docs/source/conf.py index 96b6671be9..8810cf4555 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,7 +54,7 @@ # The short X.Y version. version = '1.27.' # The full version, including alpha/beta/rc tags. -release = '1.27.83' +release = '1.27.84' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.