GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PAWS::CODEDEPLOY (3)

.ds Aq ’

NAME

Paws::CodeDeploy - Perl Interface to AWS AWS CodeDeploy

CONTENTS

SYNOPSIS



  use Paws;

  my $obj = Paws->service(CodeDeploy)->new;
  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 <B>OverviewB>

This is the AWS CodeDeploy API Reference. This guide provides descriptions of the AWS CodeDeploy APIs. For additional information, see the AWS CodeDeploy User Guide.

<B>Using the APIsB>

You can use the AWS CodeDeploy APIs to work with the following items:
o Applications are unique identifiers that AWS CodeDeploy uses to ensure that 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.

o Deployment configurations are sets of deployment rules and deployment success and failure conditions that AWS CodeDeploy uses during deployments.

You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment configurations.

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

o 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 instances.

o Deployments represent the process of deploying revisions to instances.

You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments.

o Application revisions are archive files that are stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, any deployment scripts, and similar) along with an Application Specification file (AppSpec file). (The AppSpec file is unique to AWS CodeDeploy; it defines a series of deployment actions that you want AWS CodeDeploy to execute.) An application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both (for application revisions that are stored in Amazon S3 buckets) or by its repository name and commit ID (for applications revisions that are stored in GitHub repositories). 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.

    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.

    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 a new 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 new deployment configuration.

    CreateDeploymentGroup(applicationName => Str, deploymentGroupName => Str, serviceRoleArn => Str, [autoScalingGroups => ArrayRef[Str], deploymentConfigName => Str, ec2TagFilters => ArrayRef[Paws::CodeDeploy::EC2TagFilter], onPremisesInstanceTagFilters => ArrayRef[Paws::CodeDeploy::TagFilter]])

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

Returns: a Paws::CodeDeploy::CreateDeploymentGroupOutput instance

Creates a new deployment group for application revisions to be deployed to.

    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. Also, 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 instances 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 within 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 one or more on-premises instance names.

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 an existing application’s name.

    UpdateDeploymentGroup(applicationName => Str, currentDeploymentGroupName => Str, [autoScalingGroups => ArrayRef[Str], deploymentConfigName => Str, ec2TagFilters => ArrayRef[Paws::CodeDeploy::EC2TagFilter], newDeploymentGroupName => Str, onPremisesInstanceTagFilters => ArrayRef[Paws::CodeDeploy::TagFilter], serviceRoleArn => Str])

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

Returns: a Paws::CodeDeploy::UpdateDeploymentGroupOutput instance

Changes information about an existing 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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PAWS::CODEDEPLOY (3) 2015-08-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.