Client — AWS SDK for Ruby V3 (original) (raw)

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Instance Method Details

#add_tags_to_on_premises_instances(params = {}) ⇒ Struct

Adds tags to on-premises instances.

#batch_get_application_revisions(params = {}) ⇒ Types::BatchGetApplicationRevisionsOutput

Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.

#batch_get_applications(params = {}) ⇒ Types::BatchGetApplicationsOutput

Gets information about one or more applications. The maximum number of applications that can be returned is 100.

#batch_get_deployment_groups(params = {}) ⇒ Types::BatchGetDeploymentGroupsOutput

Gets information about one or more deployment groups.

#batch_get_deployment_instances(params = {}) ⇒ Types::BatchGetDeploymentInstancesOutput

This method works, but is deprecated. Use BatchGetDeploymentTargetsinstead.

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.

#batch_get_deployment_targets(params = {}) ⇒ Types::BatchGetDeploymentTargetsOutput

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.

#batch_get_deployments(params = {}) ⇒ Types::BatchGetDeploymentsOutput

Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.

#batch_get_on_premises_instances(params = {}) ⇒ Types::BatchGetOnPremisesInstancesOutput

Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.

#continue_deployment(params = {}) ⇒ Struct

For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)

#create_application(params = {}) ⇒ Types::CreateApplicationOutput

#create_deployment(params = {}) ⇒ Types::CreateDeploymentOutput

Deploys an application revision through the specified deployment group.

#create_deployment_config(params = {}) ⇒ Types::CreateDeploymentConfigOutput

Creates a deployment configuration.

#create_deployment_group(params = {}) ⇒ Types::CreateDeploymentGroupOutput

Creates a deployment group to which application revisions are deployed.

#delete_application(params = {}) ⇒ Struct

#delete_deployment_config(params = {}) ⇒ Struct

Deletes a deployment configuration.

A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.

#delete_deployment_group(params = {}) ⇒ Types::DeleteDeploymentGroupOutput

Deletes a deployment group.

#delete_git_hub_account_token(params = {}) ⇒ Types::DeleteGitHubAccountTokenOutput

Deletes a GitHub account connection.

#delete_resources_by_external_id(params = {}) ⇒ Struct

Deletes resources linked to an external ID. This action only applies if you have configured blue/green deployments through CloudFormation.

It is not necessary to call this action directly. CloudFormation calls it on your behalf when it needs to delete stack resources. This action is offered publicly in case you need to delete resources to comply with General Data Protection Regulation (GDPR) requirements.

#deregister_on_premises_instance(params = {}) ⇒ Struct

Deregisters an on-premises instance.

#get_application(params = {}) ⇒ Types::GetApplicationOutput

Gets information about an application.

#get_application_revision(params = {}) ⇒ Types::GetApplicationRevisionOutput

Gets information about an application revision.

#get_deployment(params = {}) ⇒ Types::GetDeploymentOutput

Gets information about a deployment.

The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and the sha256property of the returned appSpecContent object to get the content of the deployment’s AppSpec file.

The following waiters are defined for this operation (see #wait_until for detailed usage):

• deployment_successful

#get_deployment_config(params = {}) ⇒ Types::GetDeploymentConfigOutput

Gets information about a deployment configuration.

#get_deployment_group(params = {}) ⇒ Types::GetDeploymentGroupOutput

Gets information about a deployment group.

#get_deployment_instance(params = {}) ⇒ Types::GetDeploymentInstanceOutput

Gets information about an instance as part of a deployment.

#get_deployment_target(params = {}) ⇒ Types::GetDeploymentTargetOutput

Returns information about a deployment target.

#get_on_premises_instance(params = {}) ⇒ Types::GetOnPremisesInstanceOutput

Gets information about an on-premises instance.

#list_application_revisions(params = {}) ⇒ Types::ListApplicationRevisionsOutput

Lists information about revisions for an application.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

#list_applications(params = {}) ⇒ Types::ListApplicationsOutput

Lists the applications registered with the user or Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

#list_deployment_configs(params = {}) ⇒ Types::ListDeploymentConfigsOutput

Lists the deployment configurations with the user or Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

#list_deployment_groups(params = {}) ⇒ Types::ListDeploymentGroupsOutput

Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

#list_deployment_instances(params = {}) ⇒ Types::ListDeploymentInstancesOutput

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 user or Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

#list_deployment_targets(params = {}) ⇒ Types::ListDeploymentTargetsOutput

Returns an array of target IDs that are associated a deployment.

#list_deployments(params = {}) ⇒ Types::ListDeploymentsOutput

Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

#list_git_hub_account_token_names(params = {}) ⇒ Types::ListGitHubAccountTokenNamesOutput

Lists the names of stored connections to GitHub accounts.

#list_on_premises_instances(params = {}) ⇒ Types::ListOnPremisesInstancesOutput

Gets a list of names for one or more on-premises instances.

Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources.

#put_lifecycle_event_hook_execution_status(params = {}) ⇒ Types::PutLifecycleEventHookExecutionStatusOutput

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 areBeforeInstall, AfterInstall, AfterAllowTestTraffic,BeforeAllowTraffic, and AfterAllowTraffic. Lambda validation functions return Succeeded or Failed. For more information, seeAppSpec 'hooks' Section for an Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.

#register_application_revision(params = {}) ⇒ Struct

Registers with CodeDeploy a revision for the specified application.

#register_on_premises_instance(params = {}) ⇒ Struct

Registers an on-premises instance.

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.

#remove_tags_from_on_premises_instances(params = {}) ⇒ Struct

Removes one or more tags from one or more on-premises instances.

#skip_wait_time_for_instance_termination(params = {}) ⇒ Struct

In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.

#stop_deployment(params = {}) ⇒ Types::StopDeploymentOutput

Attempts to stop an ongoing deployment.

#tag_resource(params = {}) ⇒ Struct

Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.

#untag_resource(params = {}) ⇒ Struct

Disassociates a resource from a list of tags. The resource is identified by the ResourceArn input parameter. The tags are identified by the list of keys in the TagKeys input parameter.

#update_application(params = {}) ⇒ Struct

Changes the name of an application.

#update_deployment_group(params = {}) ⇒ Types::UpdateDeploymentGroupOutput

Changes information about a deployment group.

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

• It is successful
• It enters a terminal state
• It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend fromWaiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.