Struct aws_sdk_codedeploy::client::Client
source · [−]pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }Expand description
Client for AWS CodeDeploy
Client for invoking operations on AWS CodeDeploy. Each operation on AWS CodeDeploy is a method on this
this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_codedeploy::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_codedeploy::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_codedeploy::Client::from_conf(config);Implementations
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
Constructs a fluent builder for the AddTagsToOnPremisesInstances operation.
- The fluent builder is configurable:
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):The tag key-value pairs to add to the on-premises instances.
Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.
instance_names(Vec<String>)/set_instance_names(Option<Vec<String>>):The names of the on-premises instances to which to add tags.
- On success, responds with
AddTagsToOnPremisesInstancesOutput - On failure, responds with
SdkError<AddTagsToOnPremisesInstancesError>
Constructs a fluent builder for the BatchGetApplicationRevisions operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application about which to get revision information.
revisions(Vec<RevisionLocation>)/set_revisions(Option<Vec<RevisionLocation>>):An array of
RevisionLocationobjects that specify information to get about the application revisions, including type and location. The maximum number ofRevisionLocationobjects you can specify is 25.
- On success, responds with
BatchGetApplicationRevisionsOutputwith field(s):application_name(Option<String>):The name of the application that corresponds to the revisions.
error_message(Option<String>):Information about errors that might have occurred during the API call.
revisions(Option<Vec<RevisionInfo>>):Additional information about the revisions, including the type and location.
- On failure, responds with
SdkError<BatchGetApplicationRevisionsError>
Constructs a fluent builder for the BatchGetApplications operation.
- The fluent builder is configurable:
application_names(Vec<String>)/set_application_names(Option<Vec<String>>):A list of application names separated by spaces. The maximum number of application names you can specify is 100.
- On success, responds with
BatchGetApplicationsOutputwith field(s):applications_info(Option<Vec<ApplicationInfo>>):Information about the applications.
- On failure, responds with
SdkError<BatchGetApplicationsError>
Constructs a fluent builder for the BatchGetDeploymentGroups operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
deployment_group_names(Vec<String>)/set_deployment_group_names(Option<Vec<String>>):The names of the deployment groups.
- On success, responds with
BatchGetDeploymentGroupsOutputwith field(s):deployment_groups_info(Option<Vec<DeploymentGroupInfo>>):Information about the deployment groups.
error_message(Option<String>):Information about errors that might have occurred during the API call.
- On failure, responds with
SdkError<BatchGetDeploymentGroupsError>
Constructs a fluent builder for the BatchGetDeploymentInstances operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The unique ID of a deployment.
instance_ids(Vec<String>)/set_instance_ids(Option<Vec<String>>):The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.
- On success, responds with
BatchGetDeploymentInstancesOutputwith field(s):instances_summary(Option<Vec<InstanceSummary>>):Information about the instance.
error_message(Option<String>):Information about errors that might have occurred during the API call.
- On failure, responds with
SdkError<BatchGetDeploymentInstancesError>
Constructs a fluent builder for the BatchGetDeployments operation.
- The fluent builder is configurable:
deployment_ids(Vec<String>)/set_deployment_ids(Option<Vec<String>>):A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.
- On success, responds with
BatchGetDeploymentsOutputwith field(s):deployments_info(Option<Vec<DeploymentInfo>>):Information about the deployments.
- On failure, responds with
SdkError<BatchGetDeploymentsError>
Constructs a fluent builder for the BatchGetDeploymentTargets operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The unique ID of a deployment.
target_ids(Vec<String>)/set_target_ids(Option<Vec<String>>):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
. 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.
-
- On success, responds with
BatchGetDeploymentTargetsOutputwith field(s):deployment_targets(Option<Vec<DeploymentTarget>>):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.
-
- On failure, responds with
SdkError<BatchGetDeploymentTargetsError>
Constructs a fluent builder for the BatchGetOnPremisesInstances operation.
- The fluent builder is configurable:
instance_names(Vec<String>)/set_instance_names(Option<Vec<String>>):The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.
- On success, responds with
BatchGetOnPremisesInstancesOutputwith field(s):instance_infos(Option<Vec<InstanceInfo>>):Information about the on-premises instances.
- On failure, responds with
SdkError<BatchGetOnPremisesInstancesError>
Constructs a fluent builder for the ContinueDeployment operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.
deployment_wait_type(DeploymentWaitType)/set_deployment_wait_type(Option<DeploymentWaitType>):The status of the deployment’s waiting period.
READY_WAITindicates that the deployment is ready to start shifting traffic.TERMINATION_WAITindicates that the traffic is shifted, but the original target is not terminated.
- On success, responds with
ContinueDeploymentOutput - On failure, responds with
SdkError<ContinueDeploymentError>
Constructs a fluent builder for the CreateApplication operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of the application. This name must be unique with the applicable IAM user or AWS account.
compute_platform(ComputePlatform)/set_compute_platform(Option<ComputePlatform>):The destination platform type for the deployment (
Lambda,Server, orECS).tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
- On success, responds with
CreateApplicationOutputwith field(s):application_id(Option<String>):A unique application ID.
- On failure, responds with
SdkError<CreateApplicationError>
Constructs a fluent builder for the CreateDeployment operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
deployment_group_name(impl Into<String>)/set_deployment_group_name(Option<String>):The name of the deployment group.
revision(RevisionLocation)/set_revision(Option<RevisionLocation>):The type and location of the revision to deploy.
deployment_config_name(impl Into<String>)/set_deployment_config_name(Option<String>):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.OneAtATimeis used by default.description(impl Into<String>)/set_description(Option<String>):A comment about the deployment.
ignore_application_stop_failures(bool)/set_ignore_application_stop_failures(bool):If true, then if an
ApplicationStop,BeforeBlockTraffic, orAfterBlockTrafficdeployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, ifApplicationStopfails, the deployment continues withDownloadBundle. IfBeforeBlockTrafficfails, the deployment continues withBlockTraffic. IfAfterBlockTrafficfails, the deployment continues withApplicationStop.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, andAfterBlockTrafficin 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
ignoreApplicationStopFailuresto specify that theApplicationStop,BeforeBlockTraffic, andAfterBlockTrafficfailures should be ignored.target_instances(TargetInstances)/set_target_instances(Option<TargetInstances>):Information about the instances that belong to the replacement environment in a blue/green deployment.
auto_rollback_configuration(AutoRollbackConfiguration)/set_auto_rollback_configuration(Option<AutoRollbackConfiguration>):Configuration information for an automatic rollback that is added when a deployment is created.
update_outdated_instances_only(bool)/set_update_outdated_instances_only(bool):Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
file_exists_behavior(FileExistsBehavior)/set_file_exists_behavior(Option<FileExistsBehavior>):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
fileExistsBehaviorparameter 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.
-
- On success, responds with
CreateDeploymentOutputwith field(s):deployment_id(Option<String>):The unique ID of a deployment.
- On failure, responds with
SdkError<CreateDeploymentError>
Constructs a fluent builder for the CreateDeploymentConfig operation.
- The fluent builder is configurable:
deployment_config_name(impl Into<String>)/set_deployment_config_name(Option<String>):The name of the deployment configuration to create.
minimum_healthy_hosts(MinimumHealthyHosts)/set_minimum_healthy_hosts(Option<MinimumHealthyHosts>):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.
-
traffic_routing_config(TrafficRoutingConfig)/set_traffic_routing_config(Option<TrafficRoutingConfig>):The configuration that specifies how the deployment traffic is routed.
compute_platform(ComputePlatform)/set_compute_platform(Option<ComputePlatform>):The destination platform type for the deployment (
Lambda,Server, orECS).
- On success, responds with
CreateDeploymentConfigOutputwith field(s):deployment_config_id(Option<String>):A unique deployment configuration ID.
- On failure, responds with
SdkError<CreateDeploymentConfigError>
Constructs a fluent builder for the CreateDeploymentGroup operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
deployment_group_name(impl Into<String>)/set_deployment_group_name(Option<String>):The name of a new deployment group for the specified application.
deployment_config_name(impl Into<String>)/set_deployment_config_name(Option<String>):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.OneAtATimeis 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.
ec2_tag_filters(Vec<Ec2TagFilter>)/set_ec2_tag_filters(Option<Vec<Ec2TagFilter>>):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.
on_premises_instance_tag_filters(Vec<TagFilter>)/set_on_premises_instance_tag_filters(Option<Vec<TagFilter>>):The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as
OnPremisesTagSet.auto_scaling_groups(Vec<String>)/set_auto_scaling_groups(Option<Vec<String>>):A list of associated Amazon EC2 Auto Scaling groups.
service_role_arn(impl Into<String>)/set_service_role_arn(Option<String>):A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on the user’s behalf when interacting with AWS services.
trigger_configurations(Vec<TriggerConfig>)/set_trigger_configurations(Option<Vec<TriggerConfig>>):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.
alarm_configuration(AlarmConfiguration)/set_alarm_configuration(Option<AlarmConfiguration>):Information to add about Amazon CloudWatch alarms when the deployment group is created.
auto_rollback_configuration(AutoRollbackConfiguration)/set_auto_rollback_configuration(Option<AutoRollbackConfiguration>):Configuration information for an automatic rollback that is added when a deployment group is created.
outdated_instances_strategy(OutdatedInstancesStrategy)/set_outdated_instances_strategy(Option<OutdatedInstancesStrategy>):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
UPDATEor 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.deployment_style(DeploymentStyle)/set_deployment_style(Option<DeploymentStyle>):Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.
blue_green_deployment_configuration(BlueGreenDeploymentConfiguration)/set_blue_green_deployment_configuration(Option<BlueGreenDeploymentConfiguration>):Information about blue/green deployment options for a deployment group.
load_balancer_info(LoadBalancerInfo)/set_load_balancer_info(Option<LoadBalancerInfo>):Information about the load balancer used in a deployment.
ec2_tag_set(Ec2TagSet)/set_ec2_tag_set(Option<Ec2TagSet>):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.ecs_services(Vec<EcsService>)/set_ecs_services(Option<Vec<EcsService>>):The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format
.: on_premises_tag_set(OnPremisesTagSet)/set_on_premises_tag_set(Option<OnPremisesTagSet>):Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as
onPremisesInstanceTagFilters.tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
- On success, responds with
CreateDeploymentGroupOutputwith field(s):deployment_group_id(Option<String>):A unique deployment group ID.
- On failure, responds with
SdkError<CreateDeploymentGroupError>
Constructs a fluent builder for the DeleteApplication operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
- On success, responds with
DeleteApplicationOutput - On failure, responds with
SdkError<DeleteApplicationError>
Constructs a fluent builder for the DeleteDeploymentConfig operation.
- The fluent builder is configurable:
deployment_config_name(impl Into<String>)/set_deployment_config_name(Option<String>):The name of a deployment configuration associated with the IAM user or AWS account.
- On success, responds with
DeleteDeploymentConfigOutput - On failure, responds with
SdkError<DeleteDeploymentConfigError>
Constructs a fluent builder for the DeleteDeploymentGroup operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
deployment_group_name(impl Into<String>)/set_deployment_group_name(Option<String>):The name of a deployment group for the specified application.
- On success, responds with
DeleteDeploymentGroupOutputwith field(s):hooks_not_cleaned_up(Option<Vec<AutoScalingGroup>>):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.
- On failure, responds with
SdkError<DeleteDeploymentGroupError>
Constructs a fluent builder for the DeleteGitHubAccountToken operation.
- The fluent builder is configurable:
token_name(impl Into<String>)/set_token_name(Option<String>):The name of the GitHub account connection to delete.
- On success, responds with
DeleteGitHubAccountTokenOutputwith field(s):token_name(Option<String>):The name of the GitHub account connection that was deleted.
- On failure, responds with
SdkError<DeleteGitHubAccountTokenError>
Constructs a fluent builder for the DeleteResourcesByExternalId operation.
- The fluent builder is configurable:
external_id(impl Into<String>)/set_external_id(Option<String>):The unique ID of an external resource (for example, a CloudFormation stack ID) that is linked to one or more CodeDeploy resources.
- On success, responds with
DeleteResourcesByExternalIdOutput - On failure, responds with
SdkError<DeleteResourcesByExternalIdError>
Constructs a fluent builder for the DeregisterOnPremisesInstance operation.
- The fluent builder is configurable:
instance_name(impl Into<String>)/set_instance_name(Option<String>):The name of the on-premises instance to deregister.
- On success, responds with
DeregisterOnPremisesInstanceOutput - On failure, responds with
SdkError<DeregisterOnPremisesInstanceError>
Constructs a fluent builder for the GetApplication operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
- On success, responds with
GetApplicationOutputwith field(s):application(Option<ApplicationInfo>):Information about the application.
- On failure, responds with
SdkError<GetApplicationError>
Constructs a fluent builder for the GetApplicationRevision operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of the application that corresponds to the revision.
revision(RevisionLocation)/set_revision(Option<RevisionLocation>):Information about the application revision to get, including type and location.
- On success, responds with
GetApplicationRevisionOutputwith field(s):application_name(Option<String>):The name of the application that corresponds to the revision.
revision(Option<RevisionLocation>):Additional information about the revision, including type and location.
revision_info(Option<GenericRevisionInfo>):General information about the revision.
- On failure, responds with
SdkError<GetApplicationRevisionError>
Constructs a fluent builder for the GetDeployment operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The unique ID of a deployment associated with the IAM user or AWS account.
- On success, responds with
GetDeploymentOutputwith field(s):deployment_info(Option<DeploymentInfo>):Information about the deployment.
- On failure, responds with
SdkError<GetDeploymentError>
Constructs a fluent builder for the GetDeploymentConfig operation.
- The fluent builder is configurable:
deployment_config_name(impl Into<String>)/set_deployment_config_name(Option<String>):The name of a deployment configuration associated with the IAM user or AWS account.
- On success, responds with
GetDeploymentConfigOutputwith field(s):deployment_config_info(Option<DeploymentConfigInfo>):Information about the deployment configuration.
- On failure, responds with
SdkError<GetDeploymentConfigError>
Constructs a fluent builder for the GetDeploymentGroup operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
deployment_group_name(impl Into<String>)/set_deployment_group_name(Option<String>):The name of a deployment group for the specified application.
- On success, responds with
GetDeploymentGroupOutputwith field(s):deployment_group_info(Option<DeploymentGroupInfo>):Information about the deployment group.
- On failure, responds with
SdkError<GetDeploymentGroupError>
Constructs a fluent builder for the GetDeploymentInstance operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The unique ID of a deployment.
instance_id(impl Into<String>)/set_instance_id(Option<String>):The unique ID of an instance in the deployment group.
- On success, responds with
GetDeploymentInstanceOutputwith field(s):instance_summary(Option<InstanceSummary>):Information about the instance.
- On failure, responds with
SdkError<GetDeploymentInstanceError>
Constructs a fluent builder for the GetDeploymentTarget operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The unique ID of a deployment.
target_id(impl Into<String>)/set_target_id(Option<String>):The unique ID of a deployment target.
- On success, responds with
GetDeploymentTargetOutputwith field(s):deployment_target(Option<DeploymentTarget>):A deployment target that contains information about a deployment such as its status, lifecycle events, and when it was last updated. It also contains metadata about the deployment target. The deployment target metadata depends on the deployment target’s type (
instanceTarget,lambdaTarget, orecsTarget).
- On failure, responds with
SdkError<GetDeploymentTargetError>
Constructs a fluent builder for the GetOnPremisesInstance operation.
- The fluent builder is configurable:
instance_name(impl Into<String>)/set_instance_name(Option<String>):The name of the on-premises instance about which to get information.
- On success, responds with
GetOnPremisesInstanceOutputwith field(s):instance_info(Option<InstanceInfo>):Information about the on-premises instance.
- On failure, responds with
SdkError<GetOnPremisesInstanceError>
Constructs a fluent builder for the ListApplicationRevisions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
sort_by(ApplicationRevisionSortBy)/set_sort_by(Option<ApplicationRevisionSortBy>):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.
-
sort_order(SortOrder)/set_sort_order(Option<SortOrder>):The order in which to sort the list results:
-
ascending: ascending order. -
descending: descending order.
If not specified, the results are sorted in ascending order.
If set to null, the results are sorted in an arbitrary order.
-
s3_bucket(impl Into<String>)/set_s3_bucket(Option<String>):An Amazon S3 bucket name to limit the search for revisions.
If set to null, all of the user’s buckets are searched.
s3_key_prefix(impl Into<String>)/set_s3_key_prefix(Option<String>):A key prefix for the set of Amazon S3 objects to limit the search for revisions.
deployed(ListStateFilterAction)/set_deployed(Option<ListStateFilterAction>):Whether to list revisions based on whether the revision is the target revision of a deployment group:
-
include: List revisions that are target revisions of a deployment group. -
exclude: Do not list revisions that are target revisions of a deployment group. -
ignore: List all revisions.
-
next_token(impl Into<String>)/set_next_token(Option<String>):An identifier returned from the previous
ListApplicationRevisionscall. It can be used to return the next set of applications in the list.
- On success, responds with
ListApplicationRevisionsOutputwith field(s):revisions(Option<Vec<RevisionLocation>>):A list of locations that contain the matching revisions.
next_token(Option<String>):If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
- On failure, responds with
SdkError<ListApplicationRevisionsError>
Constructs a fluent builder for the ListApplications operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.
- On success, responds with
ListApplicationsOutputwith field(s):applications(Option<Vec<String>>):A list of application names.
next_token(Option<String>):If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications in the list.
- On failure, responds with
SdkError<ListApplicationsError>
Constructs a fluent builder for the ListDeploymentConfigs operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):An identifier returned from the previous
ListDeploymentConfigscall. It can be used to return the next set of deployment configurations in the list.
- On success, responds with
ListDeploymentConfigsOutputwith field(s):deployment_configs_list(Option<Vec<String>>):A list of deployment configurations, including built-in configurations such as
CodeDeployDefault.OneAtATime.next_token(Option<String>):If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.
- On failure, responds with
SdkError<ListDeploymentConfigsError>
Constructs a fluent builder for the ListDeploymentGroups operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
next_token(impl Into<String>)/set_next_token(Option<String>):An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.
- On success, responds with
ListDeploymentGroupsOutputwith field(s):application_name(Option<String>):The application name.
deployment_groups(Option<Vec<String>>):A list of deployment group names.
next_token(Option<String>):If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.
- On failure, responds with
SdkError<ListDeploymentGroupsError>
Constructs a fluent builder for the ListDeploymentInstances operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The unique ID of a deployment.
next_token(impl Into<String>)/set_next_token(Option<String>):An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list.
instance_status_filter(Vec<InstanceStatus>)/set_instance_status_filter(Option<Vec<InstanceStatus>>):A subset of instances to list by status:
-
Pending: Include those instances with pending deployments. -
InProgress: Include those instances where deployments are still in progress. -
Succeeded: Include those instances with successful deployments. -
Failed: Include those instances with failed deployments. -
Skipped: Include those instances with skipped deployments. -
Unknown: Include those instances with deployments in an unknown state.
-
instance_type_filter(Vec<InstanceType>)/set_instance_type_filter(Option<Vec<InstanceType>>):The set of instances in a blue/green deployment, either those in the original environment (“BLUE”) or those in the replacement environment (“GREEN”), for which you want to view instance information.
- On success, responds with
ListDeploymentInstancesOutputwith field(s):instances_list(Option<Vec<String>>):A list of instance IDs.
next_token(Option<String>):If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.
- On failure, responds with
SdkError<ListDeploymentInstancesError>
Constructs a fluent builder for the ListDeployments operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
If
applicationNameis specified, thendeploymentGroupNamemust be specified. If it is not specified, thendeploymentGroupNamemust not be specified.deployment_group_name(impl Into<String>)/set_deployment_group_name(Option<String>):The name of a deployment group for the specified application.
If
deploymentGroupNameis specified, thenapplicationNamemust be specified. If it is not specified, thenapplicationNamemust not be specified.external_id(impl Into<String>)/set_external_id(Option<String>):The unique ID of an external resource for returning deployments linked to the external resource.
include_only_statuses(Vec<DeploymentStatus>)/set_include_only_statuses(Option<Vec<DeploymentStatus>>):A subset of deployments to list by status:
-
Created: Include created deployments in the resulting list. -
Queued: Include queued deployments in the resulting list. -
In Progress: Include in-progress deployments in the resulting list. -
Succeeded: Include successful deployments in the resulting list. -
Failed: Include failed deployments in the resulting list. -
Stopped: Include stopped deployments in the resulting list.
-
create_time_range(TimeRange)/set_create_time_range(Option<TimeRange>):A time range (start and end) for returning a subset of the list of deployments.
next_token(impl Into<String>)/set_next_token(Option<String>):An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
- On success, responds with
ListDeploymentsOutputwith field(s):deployments(Option<Vec<String>>):A list of deployment IDs.
next_token(Option<String>):If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.
- On failure, responds with
SdkError<ListDeploymentsError>
Constructs a fluent builder for the ListDeploymentTargets operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The unique ID of a deployment.
next_token(impl Into<String>)/set_next_token(Option<String>):A token identifier returned from the previous
ListDeploymentTargetscall. It can be used to return the next set of deployment targets in the list.target_filters(HashMap<TargetFilterName, Vec<String>>)/set_target_filters(Option<HashMap<TargetFilterName, Vec<String>>>):A key used to filter the returned targets. The two valid values are:
-
TargetStatus- ATargetStatusfilter string can beFailed,InProgress,Pending,Ready,Skipped,Succeeded, orUnknown. -
ServerInstanceLabel- AServerInstanceLabelfilter string can beBlueorGreen.
-
- On success, responds with
ListDeploymentTargetsOutputwith field(s):target_ids(Option<Vec<String>>):The unique IDs of deployment targets.
next_token(Option<String>):If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent
ListDeploymentTargetscall to return the next set of deployment targets in the list.
- On failure, responds with
SdkError<ListDeploymentTargetsError>
Constructs a fluent builder for the ListGitHubAccountTokenNames operation.
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):An identifier returned from the previous
ListGitHubAccountTokenNamescall. It can be used to return the next set of names in the list.
- On success, responds with
ListGitHubAccountTokenNamesOutputwith field(s):token_name_list(Option<Vec<String>>):A list of names of connections to GitHub accounts.
next_token(Option<String>):If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent
ListGitHubAccountTokenNamescall to return the next set of names in the list.
- On failure, responds with
SdkError<ListGitHubAccountTokenNamesError>
Constructs a fluent builder for the ListOnPremisesInstances operation.
- The fluent builder is configurable:
registration_status(RegistrationStatus)/set_registration_status(Option<RegistrationStatus>):The registration status of the on-premises instances:
-
Deregistered: Include deregistered on-premises instances in the resulting list. -
Registered: Include registered on-premises instances in the resulting list.
-
tag_filters(Vec<TagFilter>)/set_tag_filters(Option<Vec<TagFilter>>):The on-premises instance tags that are used to restrict the on-premises instance names returned.
next_token(impl Into<String>)/set_next_token(Option<String>):An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.
- On success, responds with
ListOnPremisesInstancesOutputwith field(s):instance_names(Option<Vec<String>>):The list of matching on-premises instance names.
next_token(Option<String>):If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.
- On failure, responds with
SdkError<ListOnPremisesInstancesError>
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The ARN of a CodeDeploy resource.
ListTagsForResourcereturns all the tags associated with the resource that is identified by theResourceArn.next_token(impl Into<String>)/set_next_token(Option<String>):An identifier returned from the previous
ListTagsForResourcecall. It can be used to return the next set of applications in the list.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<Vec<Tag>>):A list of tags returned by
ListTagsForResource. The tags are associated with the resource identified by the inputResourceArnparameter.next_token(Option<String>):If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
- On failure, responds with
SdkError<ListTagsForResourceError>
pub fn put_lifecycle_event_hook_execution_status(
&self
) -> PutLifecycleEventHookExecutionStatus<C, M, R>
pub fn put_lifecycle_event_hook_execution_status(
&self
) -> PutLifecycleEventHookExecutionStatus<C, M, R>
Constructs a fluent builder for the PutLifecycleEventHookExecutionStatus operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.
lifecycle_event_hook_execution_id(impl Into<String>)/set_lifecycle_event_hook_execution_id(Option<String>):The execution ID of a deployment’s lifecycle hook. A deployment lifecycle hook is specified in the
hookssection of the AppSpec file.status(LifecycleEventStatus)/set_status(Option<LifecycleEventStatus>):The result of a Lambda function that validates a deployment lifecycle event.
SucceededandFailedare the only valid values forstatus.
- On success, responds with
PutLifecycleEventHookExecutionStatusOutputwith field(s):lifecycle_event_hook_execution_id(Option<String>):The execution ID of the lifecycle event hook. A hook is specified in the
hookssection of the deployment’s AppSpec file.
- On failure, responds with
SdkError<PutLifecycleEventHookExecutionStatusError>
Constructs a fluent builder for the RegisterApplicationRevision operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
description(impl Into<String>)/set_description(Option<String>):A comment about the revision.
revision(RevisionLocation)/set_revision(Option<RevisionLocation>):Information about the application revision to register, including type and location.
- On success, responds with
RegisterApplicationRevisionOutput - On failure, responds with
SdkError<RegisterApplicationRevisionError>
Constructs a fluent builder for the RegisterOnPremisesInstance operation.
- The fluent builder is configurable:
instance_name(impl Into<String>)/set_instance_name(Option<String>):The name of the on-premises instance to register.
iam_session_arn(impl Into<String>)/set_iam_session_arn(Option<String>):The ARN of the IAM session to associate with the on-premises instance.
iam_user_arn(impl Into<String>)/set_iam_user_arn(Option<String>):The ARN of the IAM user to associate with the on-premises instance.
- On success, responds with
RegisterOnPremisesInstanceOutput - On failure, responds with
SdkError<RegisterOnPremisesInstanceError>
Constructs a fluent builder for the RemoveTagsFromOnPremisesInstances operation.
- The fluent builder is configurable:
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):The tag key-value pairs to remove from the on-premises instances.
instance_names(Vec<String>)/set_instance_names(Option<Vec<String>>):The names of the on-premises instances from which to remove tags.
- On success, responds with
RemoveTagsFromOnPremisesInstancesOutput - On failure, responds with
SdkError<RemoveTagsFromOnPremisesInstancesError>
pub fn skip_wait_time_for_instance_termination(
&self
) -> SkipWaitTimeForInstanceTermination<C, M, R>
pub fn skip_wait_time_for_instance_termination(
&self
) -> SkipWaitTimeForInstanceTermination<C, M, R>
Constructs a fluent builder for the SkipWaitTimeForInstanceTermination operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The unique ID of a blue/green deployment for which you want to skip the instance termination wait time.
- On success, responds with
SkipWaitTimeForInstanceTerminationOutput - On failure, responds with
SdkError<SkipWaitTimeForInstanceTerminationError>
Constructs a fluent builder for the StopDeployment operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The unique ID of a deployment.
auto_rollback_enabled(bool)/set_auto_rollback_enabled(Option<bool>):Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.
- On success, responds with
StopDeploymentOutputwith field(s):status(Option<StopStatus>):The status of the stop deployment operation:
-
Pending: The stop operation is pending.
-
Succeeded: The stop operation was successful.
-
status_message(Option<String>):An accompanying status message.
- On failure, responds with
SdkError<StopDeploymentError>
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The ARN of a resource, such as a CodeDeploy application or deployment group.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):A list of tags that
TagResourceassociates with a resource. The resource is identified by theResourceArninput parameter.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) that specifies from which resource to disassociate the tags with the keys in the
TagKeysinput parameter.tag_keys(Vec<String>)/set_tag_keys(Option<Vec<String>>):A list of keys of
Tagobjects. TheTagobjects identified by the keys are disassociated from the resource specified by theResourceArninput parameter.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
Constructs a fluent builder for the UpdateApplication operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The current name of the application you want to change.
new_application_name(impl Into<String>)/set_new_application_name(Option<String>):The new name to give the application.
- On success, responds with
UpdateApplicationOutput - On failure, responds with
SdkError<UpdateApplicationError>
Constructs a fluent builder for the UpdateDeploymentGroup operation.
- The fluent builder is configurable:
application_name(impl Into<String>)/set_application_name(Option<String>):The application name that corresponds to the deployment group to update.
current_deployment_group_name(impl Into<String>)/set_current_deployment_group_name(Option<String>):The current name of the deployment group.
new_deployment_group_name(impl Into<String>)/set_new_deployment_group_name(Option<String>):The new name of the deployment group, if you want to change it.
deployment_config_name(impl Into<String>)/set_deployment_config_name(Option<String>):The replacement deployment configuration name to use, if you want to change it.
ec2_tag_filters(Vec<Ec2TagFilter>)/set_ec2_tag_filters(Option<Vec<Ec2TagFilter>>):The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
on_premises_instance_tag_filters(Vec<TagFilter>)/set_on_premises_instance_tag_filters(Option<Vec<TagFilter>>):The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
auto_scaling_groups(Vec<String>)/set_auto_scaling_groups(Option<Vec<String>>):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.
service_role_arn(impl Into<String>)/set_service_role_arn(Option<String>):A replacement ARN for the service role, if you want to change it.
trigger_configurations(Vec<TriggerConfig>)/set_trigger_configurations(Option<Vec<TriggerConfig>>):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.
alarm_configuration(AlarmConfiguration)/set_alarm_configuration(Option<AlarmConfiguration>):Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
auto_rollback_configuration(AutoRollbackConfiguration)/set_auto_rollback_configuration(Option<AutoRollbackConfiguration>):Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
outdated_instances_strategy(OutdatedInstancesStrategy)/set_outdated_instances_strategy(Option<OutdatedInstancesStrategy>):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
UPDATEor 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.deployment_style(DeploymentStyle)/set_deployment_style(Option<DeploymentStyle>):Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
blue_green_deployment_configuration(BlueGreenDeploymentConfiguration)/set_blue_green_deployment_configuration(Option<BlueGreenDeploymentConfiguration>):Information about blue/green deployment options for a deployment group.
load_balancer_info(LoadBalancerInfo)/set_load_balancer_info(Option<LoadBalancerInfo>):Information about the load balancer used in a deployment.
ec2_tag_set(Ec2TagSet)/set_ec2_tag_set(Option<Ec2TagSet>):Information about groups of tags applied to on-premises instances. The deployment group includes only EC2 instances identified by all the tag groups.
ecs_services(Vec<EcsService>)/set_ecs_services(Option<Vec<EcsService>>):The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format
.: on_premises_tag_set(OnPremisesTagSet)/set_on_premises_tag_set(Option<OnPremisesTagSet>):Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.
- On success, responds with
UpdateDeploymentGroupOutputwith field(s):hooks_not_cleaned_up(Option<Vec<AutoScalingGroup>>):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.
- On failure, responds with
SdkError<UpdateDeploymentGroupError>
Creates a client with the given service config and connector override.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for Client<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for Client<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more