CodeDeployClient Class

(QtAws::CodeDeploy::CodeDeployClient)

The CodeDeployClient class provides access to the AWS CodeDeploy service. More...

Header: #include <CodeDeployClient>
Inherits: QtAws::Core::AwsAbstractClient

Public Functions

CodeDeployClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
CodeDeployClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Public Slots

AddTagsToOnPremisesInstancesResponse *addTagsToOnPremisesInstances(const AddTagsToOnPremisesInstancesRequest &request)
BatchGetApplicationRevisionsResponse *batchGetApplicationRevisions(const BatchGetApplicationRevisionsRequest &request)
BatchGetApplicationsResponse *batchGetApplications(const BatchGetApplicationsRequest &request)
BatchGetDeploymentGroupsResponse *batchGetDeploymentGroups(const BatchGetDeploymentGroupsRequest &request)
BatchGetDeploymentInstancesResponse *batchGetDeploymentInstances(const BatchGetDeploymentInstancesRequest &request)
BatchGetDeploymentsResponse *batchGetDeployments(const BatchGetDeploymentsRequest &request)
BatchGetOnPremisesInstancesResponse *batchGetOnPremisesInstances(const BatchGetOnPremisesInstancesRequest &request)
ContinueDeploymentResponse *continueDeployment(const ContinueDeploymentRequest &request)
CreateApplicationResponse *createApplication(const CreateApplicationRequest &request)
CreateDeploymentResponse *createDeployment(const CreateDeploymentRequest &request)
CreateDeploymentConfigResponse *createDeploymentConfig(const CreateDeploymentConfigRequest &request)
CreateDeploymentGroupResponse *createDeploymentGroup(const CreateDeploymentGroupRequest &request)
DeleteApplicationResponse *deleteApplication(const DeleteApplicationRequest &request)
DeleteDeploymentConfigResponse *deleteDeploymentConfig(const DeleteDeploymentConfigRequest &request)
DeleteDeploymentGroupResponse *deleteDeploymentGroup(const DeleteDeploymentGroupRequest &request)
DeleteGitHubAccountTokenResponse *deleteGitHubAccountToken(const DeleteGitHubAccountTokenRequest &request)
DeregisterOnPremisesInstanceResponse *deregisterOnPremisesInstance(const DeregisterOnPremisesInstanceRequest &request)
GetApplicationResponse *getApplication(const GetApplicationRequest &request)
GetApplicationRevisionResponse *getApplicationRevision(const GetApplicationRevisionRequest &request)
GetDeploymentResponse *getDeployment(const GetDeploymentRequest &request)
GetDeploymentConfigResponse *getDeploymentConfig(const GetDeploymentConfigRequest &request)
GetDeploymentGroupResponse *getDeploymentGroup(const GetDeploymentGroupRequest &request)
GetDeploymentInstanceResponse *getDeploymentInstance(const GetDeploymentInstanceRequest &request)
GetOnPremisesInstanceResponse *getOnPremisesInstance(const GetOnPremisesInstanceRequest &request)
ListApplicationRevisionsResponse *listApplicationRevisions(const ListApplicationRevisionsRequest &request)
ListApplicationsResponse *listApplications(const ListApplicationsRequest &request)
ListDeploymentConfigsResponse *listDeploymentConfigs(const ListDeploymentConfigsRequest &request)
ListDeploymentGroupsResponse *listDeploymentGroups(const ListDeploymentGroupsRequest &request)
ListDeploymentInstancesResponse *listDeploymentInstances(const ListDeploymentInstancesRequest &request)
ListDeploymentsResponse *listDeployments(const ListDeploymentsRequest &request)
ListGitHubAccountTokenNamesResponse *listGitHubAccountTokenNames(const ListGitHubAccountTokenNamesRequest &request)
ListOnPremisesInstancesResponse *listOnPremisesInstances(const ListOnPremisesInstancesRequest &request)
PutLifecycleEventHookExecutionStatusResponse *putLifecycleEventHookExecutionStatus(const PutLifecycleEventHookExecutionStatusRequest &request)
RegisterApplicationRevisionResponse *registerApplicationRevision(const RegisterApplicationRevisionRequest &request)
RegisterOnPremisesInstanceResponse *registerOnPremisesInstance(const RegisterOnPremisesInstanceRequest &request)
RemoveTagsFromOnPremisesInstancesResponse *removeTagsFromOnPremisesInstances(const RemoveTagsFromOnPremisesInstancesRequest &request)
SkipWaitTimeForInstanceTerminationResponse *skipWaitTimeForInstanceTermination(const SkipWaitTimeForInstanceTerminationRequest &request)
StopDeploymentResponse *stopDeployment(const StopDeploymentRequest &request)
UpdateApplicationResponse *updateApplication(const UpdateApplicationRequest &request)
UpdateDeploymentGroupResponse *updateDeploymentGroup(const UpdateDeploymentGroupRequest &request)

Additional Inherited Members

Detailed Description

The CodeDeployClient class provides access to the AWS CodeDeploy service.

<fullname>AWS CodeDeploy</fullname>

AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, or serverless AWS Lambda

functions>

You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, 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>

<b>AWS CodeDeploy Components</b>

</p

Use the information in this guide to help you work with the following AWS CodeDeploy

components> <ul> <li>

<b>Application</b>: 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> </li> <li>

<b>Deployment group</b>: A set of individual instances or CodeDeploy Lambda applications. A Lambda deployment group contains a group of applications. An EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both.

</p </li> <li>

<b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a

deployment> </li> <li>

<b>Deployment</b>: The process and the components used in the process of updating a Lambda function or of installing content on one or more instances.

</p </li> <li>

<b>Application revisions</b>: For an AWS Lambda deployment, this is an AppSpec file that specifies the Lambda function to update and one or more functions to validate deployment lifecycle events. For an EC2/On-premises deployment, this is an archive file containing source content—source code, web pages, 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> </li> </ul>

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, and to get details about a Lambda function

deployment>

<b>AWS CodeDeploy Information Resources</b>

</p <ul> <li>

<a href="http://docs.aws.amazon.com/codedeploy/latest/userguide">AWS CodeDeploy User Guide</a>

</p </li> <li>

<a href="http://docs.aws.amazon.com/codedeploy/latest/APIReference/">AWS CodeDeploy API Reference Guide</a>

</p </li> <li>

<a href="http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html">AWS CLI Reference for AWS CodeDeploy</a>

</p </li> <li>

<a href="https://forums.aws.amazon.com/forum.jspa?forumID=179">AWS CodeDeploy Developer Forum</a>

Member Function Documentation

CodeDeployClient::CodeDeployClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a CodeDeployClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

CodeDeployClient::CodeDeployClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads CodeDeployClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddTagsToOnPremisesInstancesResponse *CodeDeployClient::addTagsToOnPremisesInstances(const AddTagsToOnPremisesInstancesRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an AddTagsToOnPremisesInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds tags to on-premises

[slot] BatchGetApplicationRevisionsResponse *CodeDeployClient::batchGetApplicationRevisions(const BatchGetApplicationRevisionsRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an BatchGetApplicationRevisionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about one or more application

[slot] BatchGetApplicationsResponse *CodeDeployClient::batchGetApplications(const BatchGetApplicationsRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an BatchGetApplicationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about one or more

[slot] BatchGetDeploymentGroupsResponse *CodeDeployClient::batchGetDeploymentGroups(const BatchGetDeploymentGroupsRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an BatchGetDeploymentGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about one or more deployment

[slot] BatchGetDeploymentInstancesResponse *CodeDeployClient::batchGetDeploymentInstances(const BatchGetDeploymentInstancesRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an BatchGetDeploymentInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about one or more instance that are part of a deployment

[slot] BatchGetDeploymentsResponse *CodeDeployClient::batchGetDeployments(const BatchGetDeploymentsRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an BatchGetDeploymentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about one or more

[slot] BatchGetOnPremisesInstancesResponse *CodeDeployClient::batchGetOnPremisesInstances(const BatchGetOnPremisesInstancesRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an BatchGetOnPremisesInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about one or more on-premises

[slot] ContinueDeploymentResponse *CodeDeployClient::continueDeployment(const ContinueDeploymentRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an ContinueDeploymentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CreateApplicationResponse *CodeDeployClient::createApplication(const CreateApplicationRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an CreateApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an

[slot] CreateDeploymentResponse *CodeDeployClient::createDeployment(const CreateDeploymentRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an CreateDeploymentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deploys an application revision through the specified deployment

[slot] CreateDeploymentConfigResponse *CodeDeployClient::createDeploymentConfig(const CreateDeploymentConfigRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an CreateDeploymentConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a deployment

[slot] CreateDeploymentGroupResponse *CodeDeployClient::createDeploymentGroup(const CreateDeploymentGroupRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an CreateDeploymentGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a deployment group to which application revisions will be

[slot] DeleteApplicationResponse *CodeDeployClient::deleteApplication(const DeleteApplicationRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an DeleteApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an

[slot] DeleteDeploymentConfigResponse *CodeDeployClient::deleteDeploymentConfig(const DeleteDeploymentConfigRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an DeleteDeploymentConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a deployment

configuration> <note>

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

[slot] DeleteDeploymentGroupResponse *CodeDeployClient::deleteDeploymentGroup(const DeleteDeploymentGroupRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an DeleteDeploymentGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a deployment

[slot] DeleteGitHubAccountTokenResponse *CodeDeployClient::deleteGitHubAccountToken(const DeleteGitHubAccountTokenRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an DeleteGitHubAccountTokenResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a GitHub account

[slot] DeregisterOnPremisesInstanceResponse *CodeDeployClient::deregisterOnPremisesInstance(const DeregisterOnPremisesInstanceRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an DeregisterOnPremisesInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deregisters an on-premises

[slot] GetApplicationResponse *CodeDeployClient::getApplication(const GetApplicationRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an GetApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about an

[slot] GetApplicationRevisionResponse *CodeDeployClient::getApplicationRevision(const GetApplicationRevisionRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an GetApplicationRevisionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about an application

[slot] GetDeploymentResponse *CodeDeployClient::getDeployment(const GetDeploymentRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an GetDeploymentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a

[slot] GetDeploymentConfigResponse *CodeDeployClient::getDeploymentConfig(const GetDeploymentConfigRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an GetDeploymentConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a deployment

[slot] GetDeploymentGroupResponse *CodeDeployClient::getDeploymentGroup(const GetDeploymentGroupRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an GetDeploymentGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a deployment

[slot] GetDeploymentInstanceResponse *CodeDeployClient::getDeploymentInstance(const GetDeploymentInstanceRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an GetDeploymentInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about an instance as part of a

[slot] GetOnPremisesInstanceResponse *CodeDeployClient::getOnPremisesInstance(const GetOnPremisesInstanceRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an GetOnPremisesInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about an on-premises

[slot] ListApplicationRevisionsResponse *CodeDeployClient::listApplicationRevisions(const ListApplicationRevisionsRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an ListApplicationRevisionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists information about revisions for an

[slot] ListApplicationsResponse *CodeDeployClient::listApplications(const ListApplicationsRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an ListApplicationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the applications registered with the applicable IAM user or AWS

[slot] ListDeploymentConfigsResponse *CodeDeployClient::listDeploymentConfigs(const ListDeploymentConfigsRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an ListDeploymentConfigsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the deployment configurations with the applicable IAM user or AWS

[slot] ListDeploymentGroupsResponse *CodeDeployClient::listDeploymentGroups(const ListDeploymentGroupsRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an ListDeploymentGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListDeploymentInstancesResponse *CodeDeployClient::listDeploymentInstances(const ListDeploymentInstancesRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an ListDeploymentInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the instance for a deployment associated with the applicable IAM user or AWS

[slot] ListDeploymentsResponse *CodeDeployClient::listDeployments(const ListDeploymentsRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an ListDeploymentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListGitHubAccountTokenNamesResponse *CodeDeployClient::listGitHubAccountTokenNames(const ListGitHubAccountTokenNamesRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an ListGitHubAccountTokenNamesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the names of stored connections to GitHub

[slot] ListOnPremisesInstancesResponse *CodeDeployClient::listOnPremisesInstances(const ListOnPremisesInstancesRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an ListOnPremisesInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] PutLifecycleEventHookExecutionStatusResponse *CodeDeployClient::putLifecycleEventHookExecutionStatus(const PutLifecycleEventHookExecutionStatusRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an PutLifecycleEventHookExecutionStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets the result of a Lambda validation function. The function validates one or both lifecycle events (<code>BeforeAllowTraffic</code> and <code>AfterAllowTraffic</code>) and returns <code>Succeeded</code> or

[slot] RegisterApplicationRevisionResponse *CodeDeployClient::registerApplicationRevision(const RegisterApplicationRevisionRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an RegisterApplicationRevisionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Registers with AWS CodeDeploy a revision for the specified

[slot] RegisterOnPremisesInstanceResponse *CodeDeployClient::registerOnPremisesInstance(const RegisterOnPremisesInstanceRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an RegisterOnPremisesInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Registers an on-premises

instance> <note>

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

[slot] RemoveTagsFromOnPremisesInstancesResponse *CodeDeployClient::removeTagsFromOnPremisesInstances(const RemoveTagsFromOnPremisesInstancesRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an RemoveTagsFromOnPremisesInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] SkipWaitTimeForInstanceTerminationResponse *CodeDeployClient::skipWaitTimeForInstanceTermination(const SkipWaitTimeForInstanceTerminationRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an SkipWaitTimeForInstanceTerminationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] StopDeploymentResponse *CodeDeployClient::stopDeployment(const StopDeploymentRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an StopDeploymentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Attempts to stop an ongoing

[slot] UpdateApplicationResponse *CodeDeployClient::updateApplication(const UpdateApplicationRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an UpdateApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Changes the name of an

[slot] UpdateDeploymentGroupResponse *CodeDeployClient::updateDeploymentGroup(const UpdateDeploymentGroupRequest &request)

Sends request to the CodeDeployClient service, and returns a pointer to an UpdateDeploymentGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Changes information about a deployment

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.