NAME

Paws::CodeDeploy - Perl Interface to AWS AWS CodeDeploy

SYNOPSIS

  use Paws;

  my $obj = Paws->service('CodeDeploy');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS CodeDeploy

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

AWS CodeDeploy User Guide (https://docs.aws.amazon.com/codedeploy/latest/userguide)
AWS CodeDeploy API Reference Guide (https://docs.aws.amazon.com/codedeploy/latest/APIReference/)
AWS CLI Reference for AWS CodeDeploy (https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html)
AWS CodeDeploy Developer Forum (https://forums.aws.amazon.com/forum.jspa?forumID=179)

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codedeploy-2014-10-06

METHODS

AddTagsToOnPremisesInstances

InstanceNames => ArrayRef[Str|Undef]
Tags => ArrayRef[Paws::CodeDeploy::Tag]

Each argument is described in detail in: Paws::CodeDeploy::AddTagsToOnPremisesInstances

Returns: nothing

Adds tags to on-premises instances.

BatchGetApplicationRevisions

ApplicationName => Str
Revisions => ArrayRef[Paws::CodeDeploy::RevisionLocation]

Each argument is described in detail in: Paws::CodeDeploy::BatchGetApplicationRevisions

Returns: a Paws::CodeDeploy::BatchGetApplicationRevisionsOutput instance

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

BatchGetApplications

ApplicationNames => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeDeploy::BatchGetApplications

Returns: a Paws::CodeDeploy::BatchGetApplicationsOutput instance

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

BatchGetDeploymentGroups

ApplicationName => Str
DeploymentGroupNames => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeDeploy::BatchGetDeploymentGroups

Returns: a Paws::CodeDeploy::BatchGetDeploymentGroupsOutput instance

Gets information about one or more deployment groups.

BatchGetDeploymentInstances

DeploymentId => Str
InstanceIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeDeploy::BatchGetDeploymentInstances

Returns: a Paws::CodeDeploy::BatchGetDeploymentInstancesOutput instance

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.

BatchGetDeployments

DeploymentIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeDeploy::BatchGetDeployments

Returns: a Paws::CodeDeploy::BatchGetDeploymentsOutput instance

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

BatchGetDeploymentTargets

[DeploymentId => Str]
[TargetIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::CodeDeploy::BatchGetDeploymentTargets

Returns: a Paws::CodeDeploy::BatchGetDeploymentTargetsOutput instance

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.

BatchGetOnPremisesInstances

InstanceNames => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeDeploy::BatchGetOnPremisesInstances

Returns: a Paws::CodeDeploy::BatchGetOnPremisesInstancesOutput instance

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

ContinueDeployment

[DeploymentId => Str]
[DeploymentWaitType => Str]

Each argument is described in detail in: Paws::CodeDeploy::ContinueDeployment

Returns: nothing

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.)

CreateApplication

ApplicationName => Str
[ComputePlatform => Str]
[Tags => ArrayRef[Paws::CodeDeploy::Tag]]

Each argument is described in detail in: Paws::CodeDeploy::CreateApplication

Returns: a Paws::CodeDeploy::CreateApplicationOutput instance

Creates an application.

CreateDeployment

ApplicationName => Str
[AutoRollbackConfiguration => Paws::CodeDeploy::AutoRollbackConfiguration]
[DeploymentConfigName => Str]
[DeploymentGroupName => Str]
[Description => Str]
[FileExistsBehavior => Str]
[IgnoreApplicationStopFailures => Bool]
[Revision => Paws::CodeDeploy::RevisionLocation]
[TargetInstances => Paws::CodeDeploy::TargetInstances]
[UpdateOutdatedInstancesOnly => Bool]

Each argument is described in detail in: Paws::CodeDeploy::CreateDeployment

Returns: a Paws::CodeDeploy::CreateDeploymentOutput instance

Deploys an application revision through the specified deployment group.

CreateDeploymentConfig

DeploymentConfigName => Str
[ComputePlatform => Str]
[MinimumHealthyHosts => Paws::CodeDeploy::MinimumHealthyHosts]
[TrafficRoutingConfig => Paws::CodeDeploy::TrafficRoutingConfig]

Each argument is described in detail in: Paws::CodeDeploy::CreateDeploymentConfig

Returns: a Paws::CodeDeploy::CreateDeploymentConfigOutput instance

Creates a deployment configuration.

CreateDeploymentGroup

ApplicationName => Str
DeploymentGroupName => Str
ServiceRoleArn => Str
[AlarmConfiguration => Paws::CodeDeploy::AlarmConfiguration]
[AutoRollbackConfiguration => Paws::CodeDeploy::AutoRollbackConfiguration]
[AutoScalingGroups => ArrayRef[Str|Undef]]
[BlueGreenDeploymentConfiguration => Paws::CodeDeploy::BlueGreenDeploymentConfiguration]
[DeploymentConfigName => Str]
[DeploymentStyle => Paws::CodeDeploy::DeploymentStyle]
[Ec2TagFilters => ArrayRef[Paws::CodeDeploy::EC2TagFilter]]
[Ec2TagSet => Paws::CodeDeploy::EC2TagSet]
[EcsServices => ArrayRef[Paws::CodeDeploy::ECSService]]
[LoadBalancerInfo => Paws::CodeDeploy::LoadBalancerInfo]
[OnPremisesInstanceTagFilters => ArrayRef[Paws::CodeDeploy::TagFilter]]
[OnPremisesTagSet => Paws::CodeDeploy::OnPremisesTagSet]
[OutdatedInstancesStrategy => Str]
[Tags => ArrayRef[Paws::CodeDeploy::Tag]]
[TriggerConfigurations => ArrayRef[Paws::CodeDeploy::TriggerConfig]]

Each argument is described in detail in: Paws::CodeDeploy::CreateDeploymentGroup

Returns: a Paws::CodeDeploy::CreateDeploymentGroupOutput instance

Creates a deployment group to which application revisions are deployed.

DeleteApplication

ApplicationName => Str

Each argument is described in detail in: Paws::CodeDeploy::DeleteApplication

Returns: nothing

Deletes an application.

DeleteDeploymentConfig

DeploymentConfigName => Str

Each argument is described in detail in: Paws::CodeDeploy::DeleteDeploymentConfig

Returns: nothing

Deletes a deployment configuration.

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

DeleteDeploymentGroup

ApplicationName => Str
DeploymentGroupName => Str

Each argument is described in detail in: Paws::CodeDeploy::DeleteDeploymentGroup

Returns: a Paws::CodeDeploy::DeleteDeploymentGroupOutput instance

Deletes a deployment group.

DeleteGitHubAccountToken

[TokenName => Str]

Each argument is described in detail in: Paws::CodeDeploy::DeleteGitHubAccountToken

Returns: a Paws::CodeDeploy::DeleteGitHubAccountTokenOutput instance

Deletes a GitHub account connection.

DeleteResourcesByExternalId

[ExternalId => Str]

Each argument is described in detail in: Paws::CodeDeploy::DeleteResourcesByExternalId

Returns: a Paws::CodeDeploy::DeleteResourcesByExternalIdOutput instance

Deletes resources linked to an external ID.

DeregisterOnPremisesInstance

InstanceName => Str

Each argument is described in detail in: Paws::CodeDeploy::DeregisterOnPremisesInstance

Returns: nothing

Deregisters an on-premises instance.

GetApplication

ApplicationName => Str

Each argument is described in detail in: Paws::CodeDeploy::GetApplication

Returns: a Paws::CodeDeploy::GetApplicationOutput instance

Gets information about an application.

GetApplicationRevision

ApplicationName => Str
Revision => Paws::CodeDeploy::RevisionLocation

Each argument is described in detail in: Paws::CodeDeploy::GetApplicationRevision

Returns: a Paws::CodeDeploy::GetApplicationRevisionOutput instance

Gets information about an application revision.

GetDeployment

DeploymentId => Str

Each argument is described in detail in: Paws::CodeDeploy::GetDeployment

Returns: a Paws::CodeDeploy::GetDeploymentOutput instance

Gets information about a deployment.

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

GetDeploymentConfig

DeploymentConfigName => Str

Each argument is described in detail in: Paws::CodeDeploy::GetDeploymentConfig

Returns: a Paws::CodeDeploy::GetDeploymentConfigOutput instance

Gets information about a deployment configuration.

GetDeploymentGroup

ApplicationName => Str
DeploymentGroupName => Str

Each argument is described in detail in: Paws::CodeDeploy::GetDeploymentGroup

Returns: a Paws::CodeDeploy::GetDeploymentGroupOutput instance

Gets information about a deployment group.

GetDeploymentInstance

DeploymentId => Str
InstanceId => Str

Each argument is described in detail in: Paws::CodeDeploy::GetDeploymentInstance

Returns: a Paws::CodeDeploy::GetDeploymentInstanceOutput instance

Gets information about an instance as part of a deployment.

GetDeploymentTarget

[DeploymentId => Str]
[TargetId => Str]

Each argument is described in detail in: Paws::CodeDeploy::GetDeploymentTarget

Returns: a Paws::CodeDeploy::GetDeploymentTargetOutput instance

Returns information about a deployment target.

GetOnPremisesInstance

InstanceName => Str

Each argument is described in detail in: Paws::CodeDeploy::GetOnPremisesInstance

Returns: a Paws::CodeDeploy::GetOnPremisesInstanceOutput instance

Gets information about an on-premises instance.

ListApplicationRevisions

ApplicationName => Str
[Deployed => Str]
[NextToken => Str]
[S3Bucket => Str]
[S3KeyPrefix => Str]
[SortBy => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeDeploy::ListApplicationRevisions

Returns: a Paws::CodeDeploy::ListApplicationRevisionsOutput instance

Lists information about revisions for an application.

ListApplications

[NextToken => Str]

Each argument is described in detail in: Paws::CodeDeploy::ListApplications

Returns: a Paws::CodeDeploy::ListApplicationsOutput instance

Lists the applications registered with the IAM user or AWS account.

ListDeploymentConfigs

[NextToken => Str]

Each argument is described in detail in: Paws::CodeDeploy::ListDeploymentConfigs

Returns: a Paws::CodeDeploy::ListDeploymentConfigsOutput instance

Lists the deployment configurations with the IAM user or AWS account.

ListDeploymentGroups

ApplicationName => Str
[NextToken => Str]

Each argument is described in detail in: Paws::CodeDeploy::ListDeploymentGroups

Returns: a Paws::CodeDeploy::ListDeploymentGroupsOutput instance

Lists the deployment groups for an application registered with the IAM user or AWS account.

ListDeploymentInstances

DeploymentId => Str
[InstanceStatusFilter => ArrayRef[Str|Undef]]
[InstanceTypeFilter => ArrayRef[Str|Undef]]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeDeploy::ListDeploymentInstances

Returns: a Paws::CodeDeploy::ListDeploymentInstancesOutput instance

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.

ListDeployments

[ApplicationName => Str]
[CreateTimeRange => Paws::CodeDeploy::TimeRange]
[DeploymentGroupName => Str]
[ExternalId => Str]
[IncludeOnlyStatuses => ArrayRef[Str|Undef]]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeDeploy::ListDeployments

Returns: a Paws::CodeDeploy::ListDeploymentsOutput instance

Lists the deployments in a deployment group for an application registered with the IAM user or AWS account.

ListDeploymentTargets

[DeploymentId => Str]
[NextToken => Str]
[TargetFilters => Paws::CodeDeploy::TargetFilters]

Each argument is described in detail in: Paws::CodeDeploy::ListDeploymentTargets

Returns: a Paws::CodeDeploy::ListDeploymentTargetsOutput instance

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

ListGitHubAccountTokenNames

[NextToken => Str]

Each argument is described in detail in: Paws::CodeDeploy::ListGitHubAccountTokenNames

Returns: a Paws::CodeDeploy::ListGitHubAccountTokenNamesOutput instance

Lists the names of stored connections to GitHub accounts.

ListOnPremisesInstances

[NextToken => Str]
[RegistrationStatus => Str]
[TagFilters => ArrayRef[Paws::CodeDeploy::TagFilter]]

Each argument is described in detail in: Paws::CodeDeploy::ListOnPremisesInstances

Returns: a Paws::CodeDeploy::ListOnPremisesInstancesOutput instance

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.

ListTagsForResource

ResourceArn => Str
[NextToken => Str]

Each argument is described in detail in: Paws::CodeDeploy::ListTagsForResource

Returns: a Paws::CodeDeploy::ListTagsForResourceOutput instance

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.

PutLifecycleEventHookExecutionStatus

[DeploymentId => Str]
[LifecycleEventHookExecutionId => Str]
[Status => Str]

Each argument is described in detail in: Paws::CodeDeploy::PutLifecycleEventHookExecutionStatus

Returns: a Paws::CodeDeploy::PutLifecycleEventHookExecutionStatusOutput instance

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 (https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-lambda) and AppSpec 'hooks' Section for an Amazon ECS Deployment (https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-ecs).

RegisterApplicationRevision

ApplicationName => Str
Revision => Paws::CodeDeploy::RevisionLocation
[Description => Str]

Each argument is described in detail in: Paws::CodeDeploy::RegisterApplicationRevision

Returns: nothing

Registers with AWS CodeDeploy a revision for the specified application.

RegisterOnPremisesInstance

InstanceName => Str
[IamSessionArn => Str]
[IamUserArn => Str]

Each argument is described in detail in: Paws::CodeDeploy::RegisterOnPremisesInstance

Returns: nothing

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.

RemoveTagsFromOnPremisesInstances

InstanceNames => ArrayRef[Str|Undef]
Tags => ArrayRef[Paws::CodeDeploy::Tag]

Each argument is described in detail in: Paws::CodeDeploy::RemoveTagsFromOnPremisesInstances

Returns: nothing

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

SkipWaitTimeForInstanceTermination

[DeploymentId => Str]

Each argument is described in detail in: Paws::CodeDeploy::SkipWaitTimeForInstanceTermination

Returns: nothing

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

StopDeployment

DeploymentId => Str
[AutoRollbackEnabled => Bool]

Each argument is described in detail in: Paws::CodeDeploy::StopDeployment

Returns: a Paws::CodeDeploy::StopDeploymentOutput instance

Attempts to stop an ongoing deployment.

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::CodeDeploy::Tag]

Each argument is described in detail in: Paws::CodeDeploy::TagResource

Returns: a Paws::CodeDeploy::TagResourceOutput instance

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

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeDeploy::UntagResource

Returns: a Paws::CodeDeploy::UntagResourceOutput instance

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.

UpdateApplication

[ApplicationName => Str]
[NewApplicationName => Str]

Each argument is described in detail in: Paws::CodeDeploy::UpdateApplication

Returns: nothing

Changes the name of an application.

UpdateDeploymentGroup

ApplicationName => Str
CurrentDeploymentGroupName => Str
[AlarmConfiguration => Paws::CodeDeploy::AlarmConfiguration]
[AutoRollbackConfiguration => Paws::CodeDeploy::AutoRollbackConfiguration]
[AutoScalingGroups => ArrayRef[Str|Undef]]
[BlueGreenDeploymentConfiguration => Paws::CodeDeploy::BlueGreenDeploymentConfiguration]
[DeploymentConfigName => Str]
[DeploymentStyle => Paws::CodeDeploy::DeploymentStyle]
[Ec2TagFilters => ArrayRef[Paws::CodeDeploy::EC2TagFilter]]
[Ec2TagSet => Paws::CodeDeploy::EC2TagSet]
[EcsServices => ArrayRef[Paws::CodeDeploy::ECSService]]
[LoadBalancerInfo => Paws::CodeDeploy::LoadBalancerInfo]
[NewDeploymentGroupName => Str]
[OnPremisesInstanceTagFilters => ArrayRef[Paws::CodeDeploy::TagFilter]]
[OnPremisesTagSet => Paws::CodeDeploy::OnPremisesTagSet]
[OutdatedInstancesStrategy => Str]
[ServiceRoleArn => Str]
[TriggerConfigurations => ArrayRef[Paws::CodeDeploy::TriggerConfig]]

Each argument is described in detail in: Paws::CodeDeploy::UpdateDeploymentGroup

Returns: a Paws::CodeDeploy::UpdateDeploymentGroupOutput instance

Changes information about a deployment group.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results