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 Overview
This reference guide provides descriptions of the AWS CodeDeploy APIs. For more information about AWS CodeDeploy, see the AWS CodeDeploy User Guide.
Using the APIs
You can use the AWS CodeDeploy APIs to work with the following:
Applications are unique identifiers used by AWS CodeDeploy to ensure the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments.
You can use the AWS CodeDeploy APIs to create, delete, get, list, and update applications.
Deployment configurations are sets of deployment rules and success and failure conditions used by AWS CodeDeploy during deployments.
You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment configurations.
Deployment groups are groups of instances to which application revisions can be deployed.
You can use the AWS CodeDeploy APIs to create, delete, get, list, and update deployment groups.
Instances represent Amazon EC2 instances to which application revisions are deployed. Instances are identified by their Amazon EC2 tags or Auto Scaling group names. Instances belong to deployment groups.
You can use the AWS CodeDeploy APIs to get and list instance.
Deployments represent the process of deploying revisions to instances.
You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments.
Application revisions are archive files stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, and deployment scripts) along with an application specification (AppSpec) file. (The AppSpec file is unique to AWS CodeDeploy; it defines the deployment actions you want AWS CodeDeploy to execute.) Ffor application revisions stored in Amazon S3 buckets, an application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For application revisions stored in GitHub repositories, an application revision is uniquely identified by its repository name and commit ID. Application revisions are deployed through deployment groups.
You can use the AWS CodeDeploy APIs to get, list, and register application revisions.
METHODS
AddTagsToOnPremisesInstances(InstanceNames => ArrayRef[Str], 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.
BatchGetApplications([ApplicationNames => ArrayRef[Str]])
Each argument is described in detail in: Paws::CodeDeploy::BatchGetApplications
Returns: a Paws::CodeDeploy::BatchGetApplicationsOutput instance
Gets information about one or more applications.
BatchGetDeploymentGroups(ApplicationName => Str, DeploymentGroupNames => ArrayRef[Str])
Each argument is described in detail in: Paws::CodeDeploy::BatchGetDeploymentGroups
Returns: a Paws::CodeDeploy::BatchGetDeploymentGroupsOutput instance
Get information about one or more deployment groups.
BatchGetDeploymentInstances(DeploymentId => Str, InstanceIds => ArrayRef[Str])
Each argument is described in detail in: Paws::CodeDeploy::BatchGetDeploymentInstances
Returns: a Paws::CodeDeploy::BatchGetDeploymentInstancesOutput instance
Gets information about one or more instance that are part of a
deployment group.
BatchGetDeployments([DeploymentIds => ArrayRef[Str]])
Each argument is described in detail in: Paws::CodeDeploy::BatchGetDeployments
Returns: a Paws::CodeDeploy::BatchGetDeploymentsOutput instance
Gets information about one or more deployments.
BatchGetOnPremisesInstances([InstanceNames => ArrayRef[Str]])
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.
CreateApplication(ApplicationName => Str)
Each argument is described in detail in: Paws::CodeDeploy::CreateApplication
Returns: a Paws::CodeDeploy::CreateApplicationOutput instance
Creates an application.
CreateDeployment(ApplicationName => Str, [DeploymentConfigName => Str, DeploymentGroupName => Str, Description => Str, IgnoreApplicationStopFailures => Bool, Revision => Paws::CodeDeploy::RevisionLocation])
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, [MinimumHealthyHosts => Paws::CodeDeploy::MinimumHealthyHosts])
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, [AutoScalingGroups => ArrayRef[Str], DeploymentConfigName => Str, Ec2TagFilters => ArrayRef[Paws::CodeDeploy::EC2TagFilter], OnPremisesInstanceTagFilters => ArrayRef[Paws::CodeDeploy::TagFilter], 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 will be
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.
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.
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.
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 applicable 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 applicable 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
applicable IAM user or AWS account.
ListDeploymentInstances(DeploymentId => Str, [InstanceStatusFilter => ArrayRef[Str], NextToken => Str])
Each argument is described in detail in: Paws::CodeDeploy::ListDeploymentInstances
Returns: a Paws::CodeDeploy::ListDeploymentInstancesOutput instance
Lists the instance for a deployment associated with the applicable IAM
user or AWS account.
ListDeployments([ApplicationName => Str, CreateTimeRange => Paws::CodeDeploy::TimeRange, DeploymentGroupName => Str, IncludeOnlyStatuses => ArrayRef[Str], 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 applicable IAM user or AWS account.
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 will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
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(IamUserArn => Str, InstanceName => Str)
Each argument is described in detail in: Paws::CodeDeploy::RegisterOnPremisesInstance
Returns: nothing
Registers an on-premises instance.
RemoveTagsFromOnPremisesInstances(InstanceNames => ArrayRef[Str], 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.
StopDeployment(DeploymentId => Str)
Each argument is described in detail in: Paws::CodeDeploy::StopDeployment
Returns: a Paws::CodeDeploy::StopDeploymentOutput instance
Attempts to stop an ongoing deployment.
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, [AutoScalingGroups => ArrayRef[Str], DeploymentConfigName => Str, Ec2TagFilters => ArrayRef[Paws::CodeDeploy::EC2TagFilter], NewDeploymentGroupName => Str, OnPremisesInstanceTagFilters => ArrayRef[Paws::CodeDeploy::TagFilter], 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.
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues