AddTagsToOnPremisesInstances

$result = $client->addTagsToOnPremisesInstances([/* ... */]);
$promise = $client->addTagsToOnPremisesInstancesAsync([/* ... */]);

Adds tags to on-premises instances.

Parameter Syntax

$result = $client->addTagsToOnPremisesInstances([
    'instanceNames' => ['<string>', ...], // REQUIRED
    'tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InstanceNameRequiredException:

An on-premises instance name was not specified.

InvalidInstanceNameException:

The on-premises instance name was specified in an invalid format.

TagRequiredException:

A tag was not specified.

InvalidTagException:

The tag was specified in an invalid format.

TagLimitExceededException:

The maximum allowed number of tags was exceeded.

InstanceLimitExceededException:

The maximum number of allowed on-premises instances in a single call was exceeded.

InstanceNotRegisteredException:

The specified on-premises instance is not registered.

BatchGetApplicationRevisions

$result = $client->batchGetApplicationRevisions([/* ... */]);
$promise = $client->batchGetApplicationRevisionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetApplicationRevisions([
    'applicationName' => '<string>', // REQUIRED
    'revisions' => [ // REQUIRED
        [
            'appSpecContent' => [
                'content' => '<string>',
                'sha256' => '<string>',
            ],
            'gitHubLocation' => [
                'commitId' => '<string>',
                'repository' => '<string>',
            ],
            'revisionType' => 'S3|GitHub|String|AppSpecContent',
            's3Location' => [
                'bucket' => '<string>',
                'bundleType' => 'tar|tgz|zip|YAML|JSON',
                'eTag' => '<string>',
                'key' => '<string>',
                'version' => '<string>',
            ],
            'string' => [
                'content' => '<string>',
                'sha256' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'applicationName' => '<string>',
    'errorMessage' => '<string>',
    'revisions' => [
        [
            'genericRevisionInfo' => [
                'deploymentGroups' => ['<string>', ...],
                'description' => '<string>',
                'firstUsedTime' => <DateTime>,
                'lastUsedTime' => <DateTime>,
                'registerTime' => <DateTime>,
            ],
            'revisionLocation' => [
                'appSpecContent' => [
                    'content' => '<string>',
                    'sha256' => '<string>',
                ],
                'gitHubLocation' => [
                    'commitId' => '<string>',
                    'repository' => '<string>',
                ],
                'revisionType' => 'S3|GitHub|String|AppSpecContent',
                's3Location' => [
                    'bucket' => '<string>',
                    'bundleType' => 'tar|tgz|zip|YAML|JSON',
                    'eTag' => '<string>',
                    'key' => '<string>',
                    'version' => '<string>',
                ],
                'string' => [
                    'content' => '<string>',
                    'sha256' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

RevisionRequiredException:

The revision ID was not specified.

InvalidRevisionException:

The revision was specified in an invalid format.

BatchLimitExceededException:

The maximum number of names or IDs allowed for this request (100) was exceeded.

BatchGetApplications

$result = $client->batchGetApplications([/* ... */]);
$promise = $client->batchGetApplicationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetApplications([
    'applicationNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationsInfo' => [
        [
            'applicationId' => '<string>',
            'applicationName' => '<string>',
            'computePlatform' => 'Server|Lambda|ECS',
            'createTime' => <DateTime>,
            'gitHubAccountName' => '<string>',
            'linkedToGitHub' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

BatchLimitExceededException:

The maximum number of names or IDs allowed for this request (100) was exceeded.

BatchGetDeploymentGroups

$result = $client->batchGetDeploymentGroups([/* ... */]);
$promise = $client->batchGetDeploymentGroupsAsync([/* ... */]);

Gets information about one or more deployment groups.

Parameter Syntax

$result = $client->batchGetDeploymentGroups([
    'applicationName' => '<string>', // REQUIRED
    'deploymentGroupNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deploymentGroupsInfo' => [
        [
            'alarmConfiguration' => [
                'alarms' => [
                    [
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'enabled' => true || false,
                'ignorePollAlarmFailure' => true || false,
            ],
            'applicationName' => '<string>',
            'autoRollbackConfiguration' => [
                'enabled' => true || false,
                'events' => ['<string>', ...],
            ],
            'autoScalingGroups' => [
                [
                    'hook' => '<string>',
                    'name' => '<string>',
                    'terminationHook' => '<string>',
                ],
                // ...
            ],
            'blueGreenDeploymentConfiguration' => [
                'deploymentReadyOption' => [
                    'actionOnTimeout' => 'CONTINUE_DEPLOYMENT|STOP_DEPLOYMENT',
                    'waitTimeInMinutes' => <integer>,
                ],
                'greenFleetProvisioningOption' => [
                    'action' => 'DISCOVER_EXISTING|COPY_AUTO_SCALING_GROUP',
                ],
                'terminateBlueInstancesOnDeploymentSuccess' => [
                    'action' => 'TERMINATE|KEEP_ALIVE',
                    'terminationWaitTimeInMinutes' => <integer>,
                ],
            ],
            'computePlatform' => 'Server|Lambda|ECS',
            'deploymentConfigName' => '<string>',
            'deploymentGroupId' => '<string>',
            'deploymentGroupName' => '<string>',
            'deploymentStyle' => [
                'deploymentOption' => 'WITH_TRAFFIC_CONTROL|WITHOUT_TRAFFIC_CONTROL',
                'deploymentType' => 'IN_PLACE|BLUE_GREEN',
            ],
            'ec2TagFilters' => [
                [
                    'Key' => '<string>',
                    'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'ec2TagSet' => [
                'ec2TagSetList' => [
                    [
                        [
                            'Key' => '<string>',
                            'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    // ...
                ],
            ],
            'ecsServices' => [
                [
                    'clusterName' => '<string>',
                    'serviceName' => '<string>',
                ],
                // ...
            ],
            'lastAttemptedDeployment' => [
                'createTime' => <DateTime>,
                'deploymentId' => '<string>',
                'endTime' => <DateTime>,
                'status' => 'Created|Queued|InProgress|Baking|Succeeded|Failed|Stopped|Ready',
            ],
            'lastSuccessfulDeployment' => [
                'createTime' => <DateTime>,
                'deploymentId' => '<string>',
                'endTime' => <DateTime>,
                'status' => 'Created|Queued|InProgress|Baking|Succeeded|Failed|Stopped|Ready',
            ],
            'loadBalancerInfo' => [
                'elbInfoList' => [
                    [
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'targetGroupInfoList' => [
                    [
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'targetGroupPairInfoList' => [
                    [
                        'prodTrafficRoute' => [
                            'listenerArns' => ['<string>', ...],
                        ],
                        'targetGroups' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'testTrafficRoute' => [
                            'listenerArns' => ['<string>', ...],
                        ],
                    ],
                    // ...
                ],
            ],
            'onPremisesInstanceTagFilters' => [
                [
                    'Key' => '<string>',
                    'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'onPremisesTagSet' => [
                'onPremisesTagSetList' => [
                    [
                        [
                            'Key' => '<string>',
                            'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    // ...
                ],
            ],
            'outdatedInstancesStrategy' => 'UPDATE|IGNORE',
            'serviceRoleArn' => '<string>',
            'targetRevision' => [
                'appSpecContent' => [
                    'content' => '<string>',
                    'sha256' => '<string>',
                ],
                'gitHubLocation' => [
                    'commitId' => '<string>',
                    'repository' => '<string>',
                ],
                'revisionType' => 'S3|GitHub|String|AppSpecContent',
                's3Location' => [
                    'bucket' => '<string>',
                    'bundleType' => 'tar|tgz|zip|YAML|JSON',
                    'eTag' => '<string>',
                    'key' => '<string>',
                    'version' => '<string>',
                ],
                'string' => [
                    'content' => '<string>',
                    'sha256' => '<string>',
                ],
            ],
            'terminationHookEnabled' => true || false,
            'triggerConfigurations' => [
                [
                    'triggerEvents' => ['<string>', ...],
                    'triggerName' => '<string>',
                    'triggerTargetArn' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'errorMessage' => '<string>',
]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

DeploymentGroupNameRequiredException:

The deployment group name was not specified.

InvalidDeploymentGroupNameException:

The deployment group name was specified in an invalid format.

BatchLimitExceededException:

The maximum number of names or IDs allowed for this request (100) was exceeded.

DeploymentConfigDoesNotExistException:

The deployment configuration does not exist with the user or Amazon Web Services account.

BatchGetDeploymentInstances

$result = $client->batchGetDeploymentInstances([/* ... */]);
$promise = $client->batchGetDeploymentInstancesAsync([/* ... */]);

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 Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. The maximum number of instances that can be returned is 25.

Parameter Syntax

$result = $client->batchGetDeploymentInstances([
    'deploymentId' => '<string>', // REQUIRED
    'instanceIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errorMessage' => '<string>',
    'instancesSummary' => [
        [
            'deploymentId' => '<string>',
            'instanceId' => '<string>',
            'instanceType' => 'Blue|Green',
            'lastUpdatedAt' => <DateTime>,
            'lifecycleEvents' => [
                [
                    'diagnostics' => [
                        'errorCode' => 'Success|ScriptMissing|ScriptNotExecutable|ScriptTimedOut|ScriptFailed|UnknownError',
                        'logTail' => '<string>',
                        'message' => '<string>',
                        'scriptName' => '<string>',
                    ],
                    'endTime' => <DateTime>,
                    'lifecycleEventName' => '<string>',
                    'startTime' => <DateTime>,
                    'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown',
                ],
                // ...
            ],
            'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown|Ready',
        ],
        // ...
    ],
]

Result Details

Errors

DeploymentIdRequiredException:

At least one deployment ID must be specified.

DeploymentDoesNotExistException:

The deployment with the user or Amazon Web Services account does not exist.

InstanceIdRequiredException:

The instance ID was not specified.

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

InvalidInstanceNameException:

The on-premises instance name was specified in an invalid format.

BatchLimitExceededException:

The maximum number of names or IDs allowed for this request (100) was exceeded.

InvalidComputePlatformException:

The computePlatform is invalid. The computePlatform should be Lambda, Server, or ECS.

BatchGetDeploymentTargets

$result = $client->batchGetDeploymentTargets([/* ... */]);
$promise = $client->batchGetDeploymentTargetsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->batchGetDeploymentTargets([
    'deploymentId' => '<string>', // REQUIRED
    'targetIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deploymentTargets' => [
        [
            'cloudFormationTarget' => [
                'deploymentId' => '<string>',
                'lastUpdatedAt' => <DateTime>,
                'lifecycleEvents' => [
                    [
                        'diagnostics' => [
                            'errorCode' => 'Success|ScriptMissing|ScriptNotExecutable|ScriptTimedOut|ScriptFailed|UnknownError',
                            'logTail' => '<string>',
                            'message' => '<string>',
                            'scriptName' => '<string>',
                        ],
                        'endTime' => <DateTime>,
                        'lifecycleEventName' => '<string>',
                        'startTime' => <DateTime>,
                        'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown',
                    ],
                    // ...
                ],
                'resourceType' => '<string>',
                'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown|Ready',
                'targetId' => '<string>',
                'targetVersionWeight' => <float>,
            ],
            'deploymentTargetType' => 'InstanceTarget|LambdaTarget|ECSTarget|CloudFormationTarget',
            'ecsTarget' => [
                'deploymentId' => '<string>',
                'lastUpdatedAt' => <DateTime>,
                'lifecycleEvents' => [
                    [
                        'diagnostics' => [
                            'errorCode' => 'Success|ScriptMissing|ScriptNotExecutable|ScriptTimedOut|ScriptFailed|UnknownError',
                            'logTail' => '<string>',
                            'message' => '<string>',
                            'scriptName' => '<string>',
                        ],
                        'endTime' => <DateTime>,
                        'lifecycleEventName' => '<string>',
                        'startTime' => <DateTime>,
                        'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown',
                    ],
                    // ...
                ],
                'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown|Ready',
                'targetArn' => '<string>',
                'targetId' => '<string>',
                'taskSetsInfo' => [
                    [
                        'desiredCount' => <integer>,
                        'identifer' => '<string>',
                        'pendingCount' => <integer>,
                        'runningCount' => <integer>,
                        'status' => '<string>',
                        'targetGroup' => [
                            'name' => '<string>',
                        ],
                        'taskSetLabel' => 'Blue|Green',
                        'trafficWeight' => <float>,
                    ],
                    // ...
                ],
            ],
            'instanceTarget' => [
                'deploymentId' => '<string>',
                'instanceLabel' => 'Blue|Green',
                'lastUpdatedAt' => <DateTime>,
                'lifecycleEvents' => [
                    [
                        'diagnostics' => [
                            'errorCode' => 'Success|ScriptMissing|ScriptNotExecutable|ScriptTimedOut|ScriptFailed|UnknownError',
                            'logTail' => '<string>',
                            'message' => '<string>',
                            'scriptName' => '<string>',
                        ],
                        'endTime' => <DateTime>,
                        'lifecycleEventName' => '<string>',
                        'startTime' => <DateTime>,
                        'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown',
                    ],
                    // ...
                ],
                'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown|Ready',
                'targetArn' => '<string>',
                'targetId' => '<string>',
            ],
            'lambdaTarget' => [
                'deploymentId' => '<string>',
                'lambdaFunctionInfo' => [
                    'currentVersion' => '<string>',
                    'functionAlias' => '<string>',
                    'functionName' => '<string>',
                    'targetVersion' => '<string>',
                    'targetVersionWeight' => <float>,
                ],
                'lastUpdatedAt' => <DateTime>,
                'lifecycleEvents' => [
                    [
                        'diagnostics' => [
                            'errorCode' => 'Success|ScriptMissing|ScriptNotExecutable|ScriptTimedOut|ScriptFailed|UnknownError',
                            'logTail' => '<string>',
                            'message' => '<string>',
                            'scriptName' => '<string>',
                        ],
                        'endTime' => <DateTime>,
                        'lifecycleEventName' => '<string>',
                        'startTime' => <DateTime>,
                        'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown',
                    ],
                    // ...
                ],
                'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown|Ready',
                'targetArn' => '<string>',
                'targetId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

DeploymentIdRequiredException:

At least one deployment ID must be specified.

DeploymentDoesNotExistException:

The deployment with the user or Amazon Web Services account does not exist.

DeploymentNotStartedException:

The specified deployment has not started.

DeploymentTargetIdRequiredException:

A deployment target ID was not provided.

InvalidDeploymentTargetIdException:

The target ID provided was not valid.

DeploymentTargetDoesNotExistException:

The provided target ID does not belong to the attempted deployment.

DeploymentTargetListSizeExceededException:

The maximum number of targets that can be associated with an Amazon ECS or Lambda deployment was exceeded. The target list of both types of deployments must have exactly one item. This exception does not apply to EC2/On-premises deployments.

InstanceDoesNotExistException:

The specified instance does not exist in the deployment group.

BatchGetDeployments

$result = $client->batchGetDeployments([/* ... */]);
$promise = $client->batchGetDeploymentsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetDeployments([
    'deploymentIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deploymentsInfo' => [
        [
            'additionalDeploymentStatusInfo' => '<string>',
            'applicationName' => '<string>',
            'autoRollbackConfiguration' => [
                'enabled' => true || false,
                'events' => ['<string>', ...],
            ],
            'blueGreenDeploymentConfiguration' => [
                'deploymentReadyOption' => [
                    'actionOnTimeout' => 'CONTINUE_DEPLOYMENT|STOP_DEPLOYMENT',
                    'waitTimeInMinutes' => <integer>,
                ],
                'greenFleetProvisioningOption' => [
                    'action' => 'DISCOVER_EXISTING|COPY_AUTO_SCALING_GROUP',
                ],
                'terminateBlueInstancesOnDeploymentSuccess' => [
                    'action' => 'TERMINATE|KEEP_ALIVE',
                    'terminationWaitTimeInMinutes' => <integer>,
                ],
            ],
            'completeTime' => <DateTime>,
            'computePlatform' => 'Server|Lambda|ECS',
            'createTime' => <DateTime>,
            'creator' => 'user|autoscaling|codeDeployRollback|CodeDeploy|CodeDeployAutoUpdate|CloudFormation|CloudFormationRollback|autoscalingTermination',
            'deploymentConfigName' => '<string>',
            'deploymentGroupName' => '<string>',
            'deploymentId' => '<string>',
            'deploymentOverview' => [
                'Failed' => <integer>,
                'InProgress' => <integer>,
                'Pending' => <integer>,
                'Ready' => <integer>,
                'Skipped' => <integer>,
                'Succeeded' => <integer>,
            ],
            'deploymentStatusMessages' => ['<string>', ...],
            'deploymentStyle' => [
                'deploymentOption' => 'WITH_TRAFFIC_CONTROL|WITHOUT_TRAFFIC_CONTROL',
                'deploymentType' => 'IN_PLACE|BLUE_GREEN',
            ],
            'description' => '<string>',
            'errorInformation' => [
                'code' => 'AGENT_ISSUE|ALARM_ACTIVE|APPLICATION_MISSING|AUTOSCALING_VALIDATION_ERROR|AUTO_SCALING_CONFIGURATION|AUTO_SCALING_IAM_ROLE_PERMISSIONS|CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND|CUSTOMER_APPLICATION_UNHEALTHY|DEPLOYMENT_GROUP_MISSING|ECS_UPDATE_ERROR|ELASTIC_LOAD_BALANCING_INVALID|ELB_INVALID_INSTANCE|HEALTH_CONSTRAINTS|HEALTH_CONSTRAINTS_INVALID|HOOK_EXECUTION_FAILURE|IAM_ROLE_MISSING|IAM_ROLE_PERMISSIONS|INTERNAL_ERROR|INVALID_ECS_SERVICE|INVALID_LAMBDA_CONFIGURATION|INVALID_LAMBDA_FUNCTION|INVALID_REVISION|MANUAL_STOP|MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION|MISSING_ELB_INFORMATION|MISSING_GITHUB_TOKEN|NO_EC2_SUBSCRIPTION|NO_INSTANCES|OVER_MAX_INSTANCES|RESOURCE_LIMIT_EXCEEDED|REVISION_MISSING|THROTTLED|TIMEOUT|CLOUDFORMATION_STACK_FAILURE',
                'message' => '<string>',
            ],
            'externalId' => '<string>',
            'fileExistsBehavior' => 'DISALLOW|OVERWRITE|RETAIN',
            'ignoreApplicationStopFailures' => true || false,
            'instanceTerminationWaitTimeStarted' => true || false,
            'loadBalancerInfo' => [
                'elbInfoList' => [
                    [
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'targetGroupInfoList' => [
                    [
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'targetGroupPairInfoList' => [
                    [
                        'prodTrafficRoute' => [
                            'listenerArns' => ['<string>', ...],
                        ],
                        'targetGroups' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'testTrafficRoute' => [
                            'listenerArns' => ['<string>', ...],
                        ],
                    ],
                    // ...
                ],
            ],
            'overrideAlarmConfiguration' => [
                'alarms' => [
                    [
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'enabled' => true || false,
                'ignorePollAlarmFailure' => true || false,
            ],
            'previousRevision' => [
                'appSpecContent' => [
                    'content' => '<string>',
                    'sha256' => '<string>',
                ],
                'gitHubLocation' => [
                    'commitId' => '<string>',
                    'repository' => '<string>',
                ],
                'revisionType' => 'S3|GitHub|String|AppSpecContent',
                's3Location' => [
                    'bucket' => '<string>',
                    'bundleType' => 'tar|tgz|zip|YAML|JSON',
                    'eTag' => '<string>',
                    'key' => '<string>',
                    'version' => '<string>',
                ],
                'string' => [
                    'content' => '<string>',
                    'sha256' => '<string>',
                ],
            ],
            'relatedDeployments' => [
                'autoUpdateOutdatedInstancesDeploymentIds' => ['<string>', ...],
                'autoUpdateOutdatedInstancesRootDeploymentId' => '<string>',
            ],
            'revision' => [
                'appSpecContent' => [
                    'content' => '<string>',
                    'sha256' => '<string>',
                ],
                'gitHubLocation' => [
                    'commitId' => '<string>',
                    'repository' => '<string>',
                ],
                'revisionType' => 'S3|GitHub|String|AppSpecContent',
                's3Location' => [
                    'bucket' => '<string>',
                    'bundleType' => 'tar|tgz|zip|YAML|JSON',
                    'eTag' => '<string>',
                    'key' => '<string>',
                    'version' => '<string>',
                ],
                'string' => [
                    'content' => '<string>',
                    'sha256' => '<string>',
                ],
            ],
            'rollbackInfo' => [
                'rollbackDeploymentId' => '<string>',
                'rollbackMessage' => '<string>',
                'rollbackTriggeringDeploymentId' => '<string>',
            ],
            'startTime' => <DateTime>,
            'status' => 'Created|Queued|InProgress|Baking|Succeeded|Failed|Stopped|Ready',
            'targetInstances' => [
                'autoScalingGroups' => ['<string>', ...],
                'ec2TagSet' => [
                    'ec2TagSetList' => [
                        [
                            [
                                'Key' => '<string>',
                                'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        // ...
                    ],
                ],
                'tagFilters' => [
                    [
                        'Key' => '<string>',
                        'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'updateOutdatedInstancesOnly' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

DeploymentIdRequiredException:

At least one deployment ID must be specified.

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

BatchLimitExceededException:

The maximum number of names or IDs allowed for this request (100) was exceeded.

BatchGetOnPremisesInstances

$result = $client->batchGetOnPremisesInstances([/* ... */]);
$promise = $client->batchGetOnPremisesInstancesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetOnPremisesInstances([
    'instanceNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'instanceInfos' => [
        [
            'deregisterTime' => <DateTime>,
            'iamSessionArn' => '<string>',
            'iamUserArn' => '<string>',
            'instanceArn' => '<string>',
            'instanceName' => '<string>',
            'registerTime' => <DateTime>,
            'tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InstanceNameRequiredException:

An on-premises instance name was not specified.

InvalidInstanceNameException:

The on-premises instance name was specified in an invalid format.

BatchLimitExceededException:

The maximum number of names or IDs allowed for this request (100) was exceeded.

ContinueDeployment

$result = $client->continueDeployment([/* ... */]);
$promise = $client->continueDeploymentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->continueDeployment([
    'deploymentId' => '<string>',
    'deploymentWaitType' => 'READY_WAIT|TERMINATION_WAIT',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DeploymentIdRequiredException:

At least one deployment ID must be specified.

DeploymentDoesNotExistException:

The deployment with the user or Amazon Web Services account does not exist.

DeploymentAlreadyCompletedException:

The deployment is already complete.

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

DeploymentIsNotInReadyStateException:

The deployment does not have a status of Ready and can't continue yet.

UnsupportedActionForDeploymentTypeException:

A call was submitted that is not supported for the specified deployment type.

InvalidDeploymentWaitTypeException:

The wait type is invalid.

InvalidDeploymentStatusException:

The specified deployment status doesn't exist or cannot be determined.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Creates an application.

Parameter Syntax

$result = $client->createApplication([
    'applicationName' => '<string>', // REQUIRED
    'computePlatform' => 'Server|Lambda|ECS',
    'tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'applicationId' => '<string>',
]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

ApplicationAlreadyExistsException:

An application with the specified name with the user or Amazon Web Services account already exists.

ApplicationLimitExceededException:

More applications were attempted to be created than are allowed.

InvalidComputePlatformException:

The computePlatform is invalid. The computePlatform should be Lambda, Server, or ECS.

InvalidTagsToAddException:

The specified tags are not valid.

CreateDeployment

$result = $client->createDeployment([/* ... */]);
$promise = $client->createDeploymentAsync([/* ... */]);

Deploys an application revision through the specified deployment group.

Parameter Syntax

$result = $client->createDeployment([
    'applicationName' => '<string>', // REQUIRED
    'autoRollbackConfiguration' => [
        'enabled' => true || false,
        'events' => ['<string>', ...],
    ],
    'deploymentConfigName' => '<string>',
    'deploymentGroupName' => '<string>',
    'description' => '<string>',
    'fileExistsBehavior' => 'DISALLOW|OVERWRITE|RETAIN',
    'ignoreApplicationStopFailures' => true || false,
    'overrideAlarmConfiguration' => [
        'alarms' => [
            [
                'name' => '<string>',
            ],
            // ...
        ],
        'enabled' => true || false,
        'ignorePollAlarmFailure' => true || false,
    ],
    'revision' => [
        'appSpecContent' => [
            'content' => '<string>',
            'sha256' => '<string>',
        ],
        'gitHubLocation' => [
            'commitId' => '<string>',
            'repository' => '<string>',
        ],
        'revisionType' => 'S3|GitHub|String|AppSpecContent',
        's3Location' => [
            'bucket' => '<string>',
            'bundleType' => 'tar|tgz|zip|YAML|JSON',
            'eTag' => '<string>',
            'key' => '<string>',
            'version' => '<string>',
        ],
        'string' => [
            'content' => '<string>',
            'sha256' => '<string>',
        ],
    ],
    'targetInstances' => [
        'autoScalingGroups' => ['<string>', ...],
        'ec2TagSet' => [
            'ec2TagSetList' => [
                [
                    [
                        'Key' => '<string>',
                        'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
        ],
        'tagFilters' => [
            [
                'Key' => '<string>',
                'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'updateOutdatedInstancesOnly' => true || false,
]);

Parameter Details

Result Syntax

[
    'deploymentId' => '<string>',
]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

DeploymentGroupNameRequiredException:

The deployment group name was not specified.

InvalidDeploymentGroupNameException:

The deployment group name was specified in an invalid format.

DeploymentGroupDoesNotExistException:

The named deployment group with the user or Amazon Web Services account does not exist.

RevisionRequiredException:

The revision ID was not specified.

RevisionDoesNotExistException:

The named revision does not exist with the user or Amazon Web Services account.

InvalidRevisionException:

The revision was specified in an invalid format.

InvalidDeploymentConfigNameException:

The deployment configuration name was specified in an invalid format.

DeploymentConfigDoesNotExistException:

The deployment configuration does not exist with the user or Amazon Web Services account.

DescriptionTooLongException:

The description is too long.

DeploymentLimitExceededException:

The number of allowed deployments was exceeded.

InvalidTargetInstancesException:

The target instance configuration is invalid. Possible causes include:

• Configuration data for target instances was entered for an in-place deployment.

• The limit of 10 tags for a tag type was exceeded.

• The combined length of the tag names exceeded the limit.

• A specified tag is not currently applied to any instances.

InvalidAlarmConfigException:

The format of the alarm configuration is invalid. Possible causes include:

• The alarm list is null.

• The alarm object is null.

• The alarm name is empty or null or exceeds the limit of 255 characters.

• Two alarms with the same name have been specified.

• The alarm configuration is enabled, but the alarm list is empty.

AlarmsLimitExceededException:

The maximum number of alarms for a deployment group (10) was exceeded.

InvalidAutoRollbackConfigException:

The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.

InvalidLoadBalancerInfoException:

An invalid load balancer name, or no load balancer name, was specified.

InvalidFileExistsBehaviorException:

An invalid fileExistsBehavior option was specified to determine how CodeDeploy handles files or directories that already exist in a deployment target location, but weren't part of the previous successful deployment. Valid values include "DISALLOW," "OVERWRITE," and "RETAIN."

InvalidRoleException:

The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.

InvalidAutoScalingGroupException:

The Auto Scaling group was specified in an invalid format or does not exist.

ThrottlingException:

An API function was called too frequently.

InvalidUpdateOutdatedInstancesOnlyValueException:

The UpdateOutdatedInstancesOnly value is invalid. For Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.

InvalidIgnoreApplicationStopFailuresValueException:

The IgnoreApplicationStopFailures value is invalid. For Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.

InvalidGitHubAccountTokenException:

The GitHub token is not valid.

InvalidTrafficRoutingConfigurationException:

The configuration that specifies how traffic is routed during a deployment is invalid.

CreateDeploymentConfig

$result = $client->createDeploymentConfig([/* ... */]);
$promise = $client->createDeploymentConfigAsync([/* ... */]);

Creates a deployment configuration.

Parameter Syntax

$result = $client->createDeploymentConfig([
    'computePlatform' => 'Server|Lambda|ECS',
    'deploymentConfigName' => '<string>', // REQUIRED
    'minimumHealthyHosts' => [
        'type' => 'HOST_COUNT|FLEET_PERCENT',
        'value' => <integer>,
    ],
    'trafficRoutingConfig' => [
        'timeBasedCanary' => [
            'canaryInterval' => <integer>,
            'canaryPercentage' => <integer>,
        ],
        'timeBasedLinear' => [
            'linearInterval' => <integer>,
            'linearPercentage' => <integer>,
        ],
        'type' => 'TimeBasedCanary|TimeBasedLinear|AllAtOnce',
    ],
    'zonalConfig' => [
        'firstZoneMonitorDurationInSeconds' => <integer>,
        'minimumHealthyHostsPerZone' => [
            'type' => 'HOST_COUNT|FLEET_PERCENT',
            'value' => <integer>,
        ],
        'monitorDurationInSeconds' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'deploymentConfigId' => '<string>',
]

Result Details

Errors

InvalidDeploymentConfigNameException:

The deployment configuration name was specified in an invalid format.

DeploymentConfigNameRequiredException:

The deployment configuration name was not specified.

DeploymentConfigAlreadyExistsException:

A deployment configuration with the specified name with the user or Amazon Web Services account already exists.

InvalidMinimumHealthyHostValueException:

The minimum healthy instance value was specified in an invalid format.

DeploymentConfigLimitExceededException:

The deployment configurations limit was exceeded.

InvalidComputePlatformException:

The computePlatform is invalid. The computePlatform should be Lambda, Server, or ECS.

InvalidTrafficRoutingConfigurationException:

The configuration that specifies how traffic is routed during a deployment is invalid.

InvalidZonalDeploymentConfigurationException:

The ZonalConfig object is not valid.

CreateDeploymentGroup

$result = $client->createDeploymentGroup([/* ... */]);
$promise = $client->createDeploymentGroupAsync([/* ... */]);

Creates a deployment group to which application revisions are deployed.

Parameter Syntax

$result = $client->createDeploymentGroup([
    'alarmConfiguration' => [
        'alarms' => [
            [
                'name' => '<string>',
            ],
            // ...
        ],
        'enabled' => true || false,
        'ignorePollAlarmFailure' => true || false,
    ],
    'applicationName' => '<string>', // REQUIRED
    'autoRollbackConfiguration' => [
        'enabled' => true || false,
        'events' => ['<string>', ...],
    ],
    'autoScalingGroups' => ['<string>', ...],
    'blueGreenDeploymentConfiguration' => [
        'deploymentReadyOption' => [
            'actionOnTimeout' => 'CONTINUE_DEPLOYMENT|STOP_DEPLOYMENT',
            'waitTimeInMinutes' => <integer>,
        ],
        'greenFleetProvisioningOption' => [
            'action' => 'DISCOVER_EXISTING|COPY_AUTO_SCALING_GROUP',
        ],
        'terminateBlueInstancesOnDeploymentSuccess' => [
            'action' => 'TERMINATE|KEEP_ALIVE',
            'terminationWaitTimeInMinutes' => <integer>,
        ],
    ],
    'deploymentConfigName' => '<string>',
    'deploymentGroupName' => '<string>', // REQUIRED
    'deploymentStyle' => [
        'deploymentOption' => 'WITH_TRAFFIC_CONTROL|WITHOUT_TRAFFIC_CONTROL',
        'deploymentType' => 'IN_PLACE|BLUE_GREEN',
    ],
    'ec2TagFilters' => [
        [
            'Key' => '<string>',
            'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
            'Value' => '<string>',
        ],
        // ...
    ],
    'ec2TagSet' => [
        'ec2TagSetList' => [
            [
                [
                    'Key' => '<string>',
                    'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                    'Value' => '<string>',
                ],
                // ...
            ],
            // ...
        ],
    ],
    'ecsServices' => [
        [
            'clusterName' => '<string>',
            'serviceName' => '<string>',
        ],
        // ...
    ],
    'loadBalancerInfo' => [
        'elbInfoList' => [
            [
                'name' => '<string>',
            ],
            // ...
        ],
        'targetGroupInfoList' => [
            [
                'name' => '<string>',
            ],
            // ...
        ],
        'targetGroupPairInfoList' => [
            [
                'prodTrafficRoute' => [
                    'listenerArns' => ['<string>', ...],
                ],
                'targetGroups' => [
                    [
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'testTrafficRoute' => [
                    'listenerArns' => ['<string>', ...],
                ],
            ],
            // ...
        ],
    ],
    'onPremisesInstanceTagFilters' => [
        [
            'Key' => '<string>',
            'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
            'Value' => '<string>',
        ],
        // ...
    ],
    'onPremisesTagSet' => [
        'onPremisesTagSetList' => [
            [
                [
                    'Key' => '<string>',
                    'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                    'Value' => '<string>',
                ],
                // ...
            ],
            // ...
        ],
    ],
    'outdatedInstancesStrategy' => 'UPDATE|IGNORE',
    'serviceRoleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'terminationHookEnabled' => true || false,
    'triggerConfigurations' => [
        [
            'triggerEvents' => ['<string>', ...],
            'triggerName' => '<string>',
            'triggerTargetArn' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'deploymentGroupId' => '<string>',
]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

DeploymentGroupNameRequiredException:

The deployment group name was not specified.

InvalidDeploymentGroupNameException:

The deployment group name was specified in an invalid format.

DeploymentGroupAlreadyExistsException:

A deployment group with the specified name with the user or Amazon Web Services account already exists.

InvalidEC2TagException:

The tag was specified in an invalid format.

InvalidTagException:

The tag was specified in an invalid format.

InvalidAutoScalingGroupException:

The Auto Scaling group was specified in an invalid format or does not exist.

InvalidDeploymentConfigNameException:

The deployment configuration name was specified in an invalid format.

DeploymentConfigDoesNotExistException:

The deployment configuration does not exist with the user or Amazon Web Services account.

RoleRequiredException:

The role ID was not specified.

InvalidRoleException:

The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.

DeploymentGroupLimitExceededException:

The deployment groups limit was exceeded.

LifecycleHookLimitExceededException:

The limit for lifecycle hooks was exceeded.

InvalidTriggerConfigException:

The trigger was specified in an invalid format.

TriggerTargetsLimitExceededException:

The maximum allowed number of triggers was exceeded.

InvalidAlarmConfigException:

The format of the alarm configuration is invalid. Possible causes include:

• The alarm list is null.

• The alarm object is null.

• The alarm name is empty or null or exceeds the limit of 255 characters.

• Two alarms with the same name have been specified.

• The alarm configuration is enabled, but the alarm list is empty.

AlarmsLimitExceededException:

The maximum number of alarms for a deployment group (10) was exceeded.

InvalidAutoRollbackConfigException:

The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.

InvalidLoadBalancerInfoException:

An invalid load balancer name, or no load balancer name, was specified.

InvalidDeploymentStyleException:

An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN." Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL."

InvalidBlueGreenDeploymentConfigurationException:

The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.

InvalidEC2TagCombinationException:

A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.

InvalidOnPremisesTagCombinationException:

A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.

TagSetListLimitExceededException:

The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.

InvalidInputException:

The input was specified in an invalid format.

ThrottlingException:

An API function was called too frequently.

InvalidECSServiceException:

The Amazon ECS service identifier is not valid.

InvalidTargetGroupPairException:

A target group pair associated with this deployment is not valid.

ECSServiceMappingLimitExceededException:

The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group.

InvalidTagsToAddException:

The specified tags are not valid.

InvalidTrafficRoutingConfigurationException:

The configuration that specifies how traffic is routed during a deployment is invalid.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

Deletes an application.

Parameter Syntax

$result = $client->deleteApplication([
    'applicationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

InvalidRoleException:

The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.

DeleteDeploymentConfig

$result = $client->deleteDeploymentConfig([/* ... */]);
$promise = $client->deleteDeploymentConfigAsync([/* ... */]);

Deletes a deployment configuration.

Parameter Syntax

$result = $client->deleteDeploymentConfig([
    'deploymentConfigName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidDeploymentConfigNameException:

The deployment configuration name was specified in an invalid format.

DeploymentConfigNameRequiredException:

The deployment configuration name was not specified.

DeploymentConfigInUseException:

The deployment configuration is still in use.

InvalidOperationException:

An invalid operation was detected.

DeleteDeploymentGroup

$result = $client->deleteDeploymentGroup([/* ... */]);
$promise = $client->deleteDeploymentGroupAsync([/* ... */]);

Deletes a deployment group.

Parameter Syntax

$result = $client->deleteDeploymentGroup([
    'applicationName' => '<string>', // REQUIRED
    'deploymentGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'hooksNotCleanedUp' => [
        [
            'hook' => '<string>',
            'name' => '<string>',
            'terminationHook' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

DeploymentGroupNameRequiredException:

The deployment group name was not specified.

InvalidDeploymentGroupNameException:

The deployment group name was specified in an invalid format.

InvalidRoleException:

The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.

DeleteGitHubAccountToken

$result = $client->deleteGitHubAccountToken([/* ... */]);
$promise = $client->deleteGitHubAccountTokenAsync([/* ... */]);

Deletes a GitHub account connection.

Parameter Syntax

$result = $client->deleteGitHubAccountToken([
    'tokenName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'tokenName' => '<string>',
]

Result Details

Errors

GitHubAccountTokenNameRequiredException:

The call is missing a required GitHub account connection name.

GitHubAccountTokenDoesNotExistException:

No GitHub account connection exists with the named specified in the call.

InvalidGitHubAccountTokenNameException:

The format of the specified GitHub account connection name is invalid.

ResourceValidationException:

The specified resource could not be validated.

OperationNotSupportedException:

The API used does not support the deployment.

DeleteResourcesByExternalId

$result = $client->deleteResourcesByExternalId([/* ... */]);
$promise = $client->deleteResourcesByExternalIdAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteResourcesByExternalId([
    'externalId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeregisterOnPremisesInstance

$result = $client->deregisterOnPremisesInstance([/* ... */]);
$promise = $client->deregisterOnPremisesInstanceAsync([/* ... */]);

Deregisters an on-premises instance.

Parameter Syntax

$result = $client->deregisterOnPremisesInstance([
    'instanceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InstanceNameRequiredException:

An on-premises instance name was not specified.

InvalidInstanceNameException:

The on-premises instance name was specified in an invalid format.

GetApplication

$result = $client->getApplication([/* ... */]);
$promise = $client->getApplicationAsync([/* ... */]);

Gets information about an application.

Parameter Syntax

$result = $client->getApplication([
    'applicationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'application' => [
        'applicationId' => '<string>',
        'applicationName' => '<string>',
        'computePlatform' => 'Server|Lambda|ECS',
        'createTime' => <DateTime>,
        'gitHubAccountName' => '<string>',
        'linkedToGitHub' => true || false,
    ],
]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

GetApplicationRevision

$result = $client->getApplicationRevision([/* ... */]);
$promise = $client->getApplicationRevisionAsync([/* ... */]);

Gets information about an application revision.

Parameter Syntax

$result = $client->getApplicationRevision([
    'applicationName' => '<string>', // REQUIRED
    'revision' => [ // REQUIRED
        'appSpecContent' => [
            'content' => '<string>',
            'sha256' => '<string>',
        ],
        'gitHubLocation' => [
            'commitId' => '<string>',
            'repository' => '<string>',
        ],
        'revisionType' => 'S3|GitHub|String|AppSpecContent',
        's3Location' => [
            'bucket' => '<string>',
            'bundleType' => 'tar|tgz|zip|YAML|JSON',
            'eTag' => '<string>',
            'key' => '<string>',
            'version' => '<string>',
        ],
        'string' => [
            'content' => '<string>',
            'sha256' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'applicationName' => '<string>',
    'revision' => [
        'appSpecContent' => [
            'content' => '<string>',
            'sha256' => '<string>',
        ],
        'gitHubLocation' => [
            'commitId' => '<string>',
            'repository' => '<string>',
        ],
        'revisionType' => 'S3|GitHub|String|AppSpecContent',
        's3Location' => [
            'bucket' => '<string>',
            'bundleType' => 'tar|tgz|zip|YAML|JSON',
            'eTag' => '<string>',
            'key' => '<string>',
            'version' => '<string>',
        ],
        'string' => [
            'content' => '<string>',
            'sha256' => '<string>',
        ],
    ],
    'revisionInfo' => [
        'deploymentGroups' => ['<string>', ...],
        'description' => '<string>',
        'firstUsedTime' => <DateTime>,
        'lastUsedTime' => <DateTime>,
        'registerTime' => <DateTime>,
    ],
]

Result Details

Errors

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

RevisionDoesNotExistException:

The named revision does not exist with the user or Amazon Web Services account.

RevisionRequiredException:

The revision ID was not specified.

InvalidRevisionException:

The revision was specified in an invalid format.

GetDeployment

$result = $client->getDeployment([/* ... */]);
$promise = $client->getDeploymentAsync([/* ... */]);

Gets information about a deployment.

Parameter Syntax

$result = $client->getDeployment([
    'deploymentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deploymentInfo' => [
        'additionalDeploymentStatusInfo' => '<string>',
        'applicationName' => '<string>',
        'autoRollbackConfiguration' => [
            'enabled' => true || false,
            'events' => ['<string>', ...],
        ],
        'blueGreenDeploymentConfiguration' => [
            'deploymentReadyOption' => [
                'actionOnTimeout' => 'CONTINUE_DEPLOYMENT|STOP_DEPLOYMENT',
                'waitTimeInMinutes' => <integer>,
            ],
            'greenFleetProvisioningOption' => [
                'action' => 'DISCOVER_EXISTING|COPY_AUTO_SCALING_GROUP',
            ],
            'terminateBlueInstancesOnDeploymentSuccess' => [
                'action' => 'TERMINATE|KEEP_ALIVE',
                'terminationWaitTimeInMinutes' => <integer>,
            ],
        ],
        'completeTime' => <DateTime>,
        'computePlatform' => 'Server|Lambda|ECS',
        'createTime' => <DateTime>,
        'creator' => 'user|autoscaling|codeDeployRollback|CodeDeploy|CodeDeployAutoUpdate|CloudFormation|CloudFormationRollback|autoscalingTermination',
        'deploymentConfigName' => '<string>',
        'deploymentGroupName' => '<string>',
        'deploymentId' => '<string>',
        'deploymentOverview' => [
            'Failed' => <integer>,
            'InProgress' => <integer>,
            'Pending' => <integer>,
            'Ready' => <integer>,
            'Skipped' => <integer>,
            'Succeeded' => <integer>,
        ],
        'deploymentStatusMessages' => ['<string>', ...],
        'deploymentStyle' => [
            'deploymentOption' => 'WITH_TRAFFIC_CONTROL|WITHOUT_TRAFFIC_CONTROL',
            'deploymentType' => 'IN_PLACE|BLUE_GREEN',
        ],
        'description' => '<string>',
        'errorInformation' => [
            'code' => 'AGENT_ISSUE|ALARM_ACTIVE|APPLICATION_MISSING|AUTOSCALING_VALIDATION_ERROR|AUTO_SCALING_CONFIGURATION|AUTO_SCALING_IAM_ROLE_PERMISSIONS|CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND|CUSTOMER_APPLICATION_UNHEALTHY|DEPLOYMENT_GROUP_MISSING|ECS_UPDATE_ERROR|ELASTIC_LOAD_BALANCING_INVALID|ELB_INVALID_INSTANCE|HEALTH_CONSTRAINTS|HEALTH_CONSTRAINTS_INVALID|HOOK_EXECUTION_FAILURE|IAM_ROLE_MISSING|IAM_ROLE_PERMISSIONS|INTERNAL_ERROR|INVALID_ECS_SERVICE|INVALID_LAMBDA_CONFIGURATION|INVALID_LAMBDA_FUNCTION|INVALID_REVISION|MANUAL_STOP|MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION|MISSING_ELB_INFORMATION|MISSING_GITHUB_TOKEN|NO_EC2_SUBSCRIPTION|NO_INSTANCES|OVER_MAX_INSTANCES|RESOURCE_LIMIT_EXCEEDED|REVISION_MISSING|THROTTLED|TIMEOUT|CLOUDFORMATION_STACK_FAILURE',
            'message' => '<string>',
        ],
        'externalId' => '<string>',
        'fileExistsBehavior' => 'DISALLOW|OVERWRITE|RETAIN',
        'ignoreApplicationStopFailures' => true || false,
        'instanceTerminationWaitTimeStarted' => true || false,
        'loadBalancerInfo' => [
            'elbInfoList' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'targetGroupInfoList' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'targetGroupPairInfoList' => [
                [
                    'prodTrafficRoute' => [
                        'listenerArns' => ['<string>', ...],
                    ],
                    'targetGroups' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'testTrafficRoute' => [
                        'listenerArns' => ['<string>', ...],
                    ],
                ],
                // ...
            ],
        ],
        'overrideAlarmConfiguration' => [
            'alarms' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'enabled' => true || false,
            'ignorePollAlarmFailure' => true || false,
        ],
        'previousRevision' => [
            'appSpecContent' => [
                'content' => '<string>',
                'sha256' => '<string>',
            ],
            'gitHubLocation' => [
                'commitId' => '<string>',
                'repository' => '<string>',
            ],
            'revisionType' => 'S3|GitHub|String|AppSpecContent',
            's3Location' => [
                'bucket' => '<string>',
                'bundleType' => 'tar|tgz|zip|YAML|JSON',
                'eTag' => '<string>',
                'key' => '<string>',
                'version' => '<string>',
            ],
            'string' => [
                'content' => '<string>',
                'sha256' => '<string>',
            ],
        ],
        'relatedDeployments' => [
            'autoUpdateOutdatedInstancesDeploymentIds' => ['<string>', ...],
            'autoUpdateOutdatedInstancesRootDeploymentId' => '<string>',
        ],
        'revision' => [
            'appSpecContent' => [
                'content' => '<string>',
                'sha256' => '<string>',
            ],
            'gitHubLocation' => [
                'commitId' => '<string>',
                'repository' => '<string>',
            ],
            'revisionType' => 'S3|GitHub|String|AppSpecContent',
            's3Location' => [
                'bucket' => '<string>',
                'bundleType' => 'tar|tgz|zip|YAML|JSON',
                'eTag' => '<string>',
                'key' => '<string>',
                'version' => '<string>',
            ],
            'string' => [
                'content' => '<string>',
                'sha256' => '<string>',
            ],
        ],
        'rollbackInfo' => [
            'rollbackDeploymentId' => '<string>',
            'rollbackMessage' => '<string>',
            'rollbackTriggeringDeploymentId' => '<string>',
        ],
        'startTime' => <DateTime>,
        'status' => 'Created|Queued|InProgress|Baking|Succeeded|Failed|Stopped|Ready',
        'targetInstances' => [
            'autoScalingGroups' => ['<string>', ...],
            'ec2TagSet' => [
                'ec2TagSetList' => [
                    [
                        [
                            'Key' => '<string>',
                            'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    // ...
                ],
            ],
            'tagFilters' => [
                [
                    'Key' => '<string>',
                    'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'updateOutdatedInstancesOnly' => true || false,
    ],
]

Result Details

Errors

DeploymentIdRequiredException:

At least one deployment ID must be specified.

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

DeploymentDoesNotExistException:

The deployment with the user or Amazon Web Services account does not exist.

GetDeploymentConfig

$result = $client->getDeploymentConfig([/* ... */]);
$promise = $client->getDeploymentConfigAsync([/* ... */]);

Gets information about a deployment configuration.

Parameter Syntax

$result = $client->getDeploymentConfig([
    'deploymentConfigName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deploymentConfigInfo' => [
        'computePlatform' => 'Server|Lambda|ECS',
        'createTime' => <DateTime>,
        'deploymentConfigId' => '<string>',
        'deploymentConfigName' => '<string>',
        'minimumHealthyHosts' => [
            'type' => 'HOST_COUNT|FLEET_PERCENT',
            'value' => <integer>,
        ],
        'trafficRoutingConfig' => [
            'timeBasedCanary' => [
                'canaryInterval' => <integer>,
                'canaryPercentage' => <integer>,
            ],
            'timeBasedLinear' => [
                'linearInterval' => <integer>,
                'linearPercentage' => <integer>,
            ],
            'type' => 'TimeBasedCanary|TimeBasedLinear|AllAtOnce',
        ],
        'zonalConfig' => [
            'firstZoneMonitorDurationInSeconds' => <integer>,
            'minimumHealthyHostsPerZone' => [
                'type' => 'HOST_COUNT|FLEET_PERCENT',
                'value' => <integer>,
            ],
            'monitorDurationInSeconds' => <integer>,
        ],
    ],
]

Result Details

Errors

InvalidDeploymentConfigNameException:

The deployment configuration name was specified in an invalid format.

DeploymentConfigNameRequiredException:

The deployment configuration name was not specified.

DeploymentConfigDoesNotExistException:

The deployment configuration does not exist with the user or Amazon Web Services account.

InvalidComputePlatformException:

The computePlatform is invalid. The computePlatform should be Lambda, Server, or ECS.

GetDeploymentGroup

$result = $client->getDeploymentGroup([/* ... */]);
$promise = $client->getDeploymentGroupAsync([/* ... */]);

Gets information about a deployment group.

Parameter Syntax

$result = $client->getDeploymentGroup([
    'applicationName' => '<string>', // REQUIRED
    'deploymentGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deploymentGroupInfo' => [
        'alarmConfiguration' => [
            'alarms' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'enabled' => true || false,
            'ignorePollAlarmFailure' => true || false,
        ],
        'applicationName' => '<string>',
        'autoRollbackConfiguration' => [
            'enabled' => true || false,
            'events' => ['<string>', ...],
        ],
        'autoScalingGroups' => [
            [
                'hook' => '<string>',
                'name' => '<string>',
                'terminationHook' => '<string>',
            ],
            // ...
        ],
        'blueGreenDeploymentConfiguration' => [
            'deploymentReadyOption' => [
                'actionOnTimeout' => 'CONTINUE_DEPLOYMENT|STOP_DEPLOYMENT',
                'waitTimeInMinutes' => <integer>,
            ],
            'greenFleetProvisioningOption' => [
                'action' => 'DISCOVER_EXISTING|COPY_AUTO_SCALING_GROUP',
            ],
            'terminateBlueInstancesOnDeploymentSuccess' => [
                'action' => 'TERMINATE|KEEP_ALIVE',
                'terminationWaitTimeInMinutes' => <integer>,
            ],
        ],
        'computePlatform' => 'Server|Lambda|ECS',
        'deploymentConfigName' => '<string>',
        'deploymentGroupId' => '<string>',
        'deploymentGroupName' => '<string>',
        'deploymentStyle' => [
            'deploymentOption' => 'WITH_TRAFFIC_CONTROL|WITHOUT_TRAFFIC_CONTROL',
            'deploymentType' => 'IN_PLACE|BLUE_GREEN',
        ],
        'ec2TagFilters' => [
            [
                'Key' => '<string>',
                'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ec2TagSet' => [
            'ec2TagSetList' => [
                [
                    [
                        'Key' => '<string>',
                        'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
        ],
        'ecsServices' => [
            [
                'clusterName' => '<string>',
                'serviceName' => '<string>',
            ],
            // ...
        ],
        'lastAttemptedDeployment' => [
            'createTime' => <DateTime>,
            'deploymentId' => '<string>',
            'endTime' => <DateTime>,
            'status' => 'Created|Queued|InProgress|Baking|Succeeded|Failed|Stopped|Ready',
        ],
        'lastSuccessfulDeployment' => [
            'createTime' => <DateTime>,
            'deploymentId' => '<string>',
            'endTime' => <DateTime>,
            'status' => 'Created|Queued|InProgress|Baking|Succeeded|Failed|Stopped|Ready',
        ],
        'loadBalancerInfo' => [
            'elbInfoList' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'targetGroupInfoList' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'targetGroupPairInfoList' => [
                [
                    'prodTrafficRoute' => [
                        'listenerArns' => ['<string>', ...],
                    ],
                    'targetGroups' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'testTrafficRoute' => [
                        'listenerArns' => ['<string>', ...],
                    ],
                ],
                // ...
            ],
        ],
        'onPremisesInstanceTagFilters' => [
            [
                'Key' => '<string>',
                'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                'Value' => '<string>',
            ],
            // ...
        ],
        'onPremisesTagSet' => [
            'onPremisesTagSetList' => [
                [
                    [
                        'Key' => '<string>',
                        'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
        ],
        'outdatedInstancesStrategy' => 'UPDATE|IGNORE',
        'serviceRoleArn' => '<string>',
        'targetRevision' => [
            'appSpecContent' => [
                'content' => '<string>',
                'sha256' => '<string>',
            ],
            'gitHubLocation' => [
                'commitId' => '<string>',
                'repository' => '<string>',
            ],
            'revisionType' => 'S3|GitHub|String|AppSpecContent',
            's3Location' => [
                'bucket' => '<string>',
                'bundleType' => 'tar|tgz|zip|YAML|JSON',
                'eTag' => '<string>',
                'key' => '<string>',
                'version' => '<string>',
            ],
            'string' => [
                'content' => '<string>',
                'sha256' => '<string>',
            ],
        ],
        'terminationHookEnabled' => true || false,
        'triggerConfigurations' => [
            [
                'triggerEvents' => ['<string>', ...],
                'triggerName' => '<string>',
                'triggerTargetArn' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

DeploymentGroupNameRequiredException:

The deployment group name was not specified.

InvalidDeploymentGroupNameException:

The deployment group name was specified in an invalid format.

DeploymentGroupDoesNotExistException:

The named deployment group with the user or Amazon Web Services account does not exist.

DeploymentConfigDoesNotExistException:

The deployment configuration does not exist with the user or Amazon Web Services account.

GetDeploymentInstance

$result = $client->getDeploymentInstance([/* ... */]);
$promise = $client->getDeploymentInstanceAsync([/* ... */]);

Gets information about an instance as part of a deployment.

Parameter Syntax

$result = $client->getDeploymentInstance([
    'deploymentId' => '<string>', // REQUIRED
    'instanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'instanceSummary' => [
        'deploymentId' => '<string>',
        'instanceId' => '<string>',
        'instanceType' => 'Blue|Green',
        'lastUpdatedAt' => <DateTime>,
        'lifecycleEvents' => [
            [
                'diagnostics' => [
                    'errorCode' => 'Success|ScriptMissing|ScriptNotExecutable|ScriptTimedOut|ScriptFailed|UnknownError',
                    'logTail' => '<string>',
                    'message' => '<string>',
                    'scriptName' => '<string>',
                ],
                'endTime' => <DateTime>,
                'lifecycleEventName' => '<string>',
                'startTime' => <DateTime>,
                'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown',
            ],
            // ...
        ],
        'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown|Ready',
    ],
]

Result Details

Errors

DeploymentIdRequiredException:

At least one deployment ID must be specified.

DeploymentDoesNotExistException:

The deployment with the user or Amazon Web Services account does not exist.

InstanceIdRequiredException:

The instance ID was not specified.

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

InstanceDoesNotExistException:

The specified instance does not exist in the deployment group.

InvalidInstanceNameException:

The on-premises instance name was specified in an invalid format.

InvalidComputePlatformException:

The computePlatform is invalid. The computePlatform should be Lambda, Server, or ECS.

GetDeploymentTarget

$result = $client->getDeploymentTarget([/* ... */]);
$promise = $client->getDeploymentTargetAsync([/* ... */]);

Returns information about a deployment target.

Parameter Syntax

$result = $client->getDeploymentTarget([
    'deploymentId' => '<string>', // REQUIRED
    'targetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deploymentTarget' => [
        'cloudFormationTarget' => [
            'deploymentId' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'lifecycleEvents' => [
                [
                    'diagnostics' => [
                        'errorCode' => 'Success|ScriptMissing|ScriptNotExecutable|ScriptTimedOut|ScriptFailed|UnknownError',
                        'logTail' => '<string>',
                        'message' => '<string>',
                        'scriptName' => '<string>',
                    ],
                    'endTime' => <DateTime>,
                    'lifecycleEventName' => '<string>',
                    'startTime' => <DateTime>,
                    'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown',
                ],
                // ...
            ],
            'resourceType' => '<string>',
            'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown|Ready',
            'targetId' => '<string>',
            'targetVersionWeight' => <float>,
        ],
        'deploymentTargetType' => 'InstanceTarget|LambdaTarget|ECSTarget|CloudFormationTarget',
        'ecsTarget' => [
            'deploymentId' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'lifecycleEvents' => [
                [
                    'diagnostics' => [
                        'errorCode' => 'Success|ScriptMissing|ScriptNotExecutable|ScriptTimedOut|ScriptFailed|UnknownError',
                        'logTail' => '<string>',
                        'message' => '<string>',
                        'scriptName' => '<string>',
                    ],
                    'endTime' => <DateTime>,
                    'lifecycleEventName' => '<string>',
                    'startTime' => <DateTime>,
                    'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown',
                ],
                // ...
            ],
            'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown|Ready',
            'targetArn' => '<string>',
            'targetId' => '<string>',
            'taskSetsInfo' => [
                [
                    'desiredCount' => <integer>,
                    'identifer' => '<string>',
                    'pendingCount' => <integer>,
                    'runningCount' => <integer>,
                    'status' => '<string>',
                    'targetGroup' => [
                        'name' => '<string>',
                    ],
                    'taskSetLabel' => 'Blue|Green',
                    'trafficWeight' => <float>,
                ],
                // ...
            ],
        ],
        'instanceTarget' => [
            'deploymentId' => '<string>',
            'instanceLabel' => 'Blue|Green',
            'lastUpdatedAt' => <DateTime>,
            'lifecycleEvents' => [
                [
                    'diagnostics' => [
                        'errorCode' => 'Success|ScriptMissing|ScriptNotExecutable|ScriptTimedOut|ScriptFailed|UnknownError',
                        'logTail' => '<string>',
                        'message' => '<string>',
                        'scriptName' => '<string>',
                    ],
                    'endTime' => <DateTime>,
                    'lifecycleEventName' => '<string>',
                    'startTime' => <DateTime>,
                    'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown',
                ],
                // ...
            ],
            'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown|Ready',
            'targetArn' => '<string>',
            'targetId' => '<string>',
        ],
        'lambdaTarget' => [
            'deploymentId' => '<string>',
            'lambdaFunctionInfo' => [
                'currentVersion' => '<string>',
                'functionAlias' => '<string>',
                'functionName' => '<string>',
                'targetVersion' => '<string>',
                'targetVersionWeight' => <float>,
            ],
            'lastUpdatedAt' => <DateTime>,
            'lifecycleEvents' => [
                [
                    'diagnostics' => [
                        'errorCode' => 'Success|ScriptMissing|ScriptNotExecutable|ScriptTimedOut|ScriptFailed|UnknownError',
                        'logTail' => '<string>',
                        'message' => '<string>',
                        'scriptName' => '<string>',
                    ],
                    'endTime' => <DateTime>,
                    'lifecycleEventName' => '<string>',
                    'startTime' => <DateTime>,
                    'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown',
                ],
                // ...
            ],
            'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown|Ready',
            'targetArn' => '<string>',
            'targetId' => '<string>',
        ],
    ],
]

Result Details

Errors

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

DeploymentIdRequiredException:

At least one deployment ID must be specified.

DeploymentDoesNotExistException:

The deployment with the user or Amazon Web Services account does not exist.

DeploymentNotStartedException:

The specified deployment has not started.

DeploymentTargetIdRequiredException:

A deployment target ID was not provided.

InvalidDeploymentTargetIdException:

The target ID provided was not valid.

DeploymentTargetDoesNotExistException:

The provided target ID does not belong to the attempted deployment.

InvalidInstanceNameException:

The on-premises instance name was specified in an invalid format.

GetOnPremisesInstance

$result = $client->getOnPremisesInstance([/* ... */]);
$promise = $client->getOnPremisesInstanceAsync([/* ... */]);

Gets information about an on-premises instance.

Parameter Syntax

$result = $client->getOnPremisesInstance([
    'instanceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'instanceInfo' => [
        'deregisterTime' => <DateTime>,
        'iamSessionArn' => '<string>',
        'iamUserArn' => '<string>',
        'instanceArn' => '<string>',
        'instanceName' => '<string>',
        'registerTime' => <DateTime>,
        'tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InstanceNameRequiredException:

An on-premises instance name was not specified.

InstanceNotRegisteredException:

The specified on-premises instance is not registered.

InvalidInstanceNameException:

The on-premises instance name was specified in an invalid format.

ListApplicationRevisions

$result = $client->listApplicationRevisions([/* ... */]);
$promise = $client->listApplicationRevisionsAsync([/* ... */]);

Lists information about revisions for an application.

Parameter Syntax

$result = $client->listApplicationRevisions([
    'applicationName' => '<string>', // REQUIRED
    'deployed' => 'include|exclude|ignore',
    'nextToken' => '<string>',
    's3Bucket' => '<string>',
    's3KeyPrefix' => '<string>',
    'sortBy' => 'registerTime|firstUsedTime|lastUsedTime',
    'sortOrder' => 'ascending|descending',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'revisions' => [
        [
            'appSpecContent' => [
                'content' => '<string>',
                'sha256' => '<string>',
            ],
            'gitHubLocation' => [
                'commitId' => '<string>',
                'repository' => '<string>',
            ],
            'revisionType' => 'S3|GitHub|String|AppSpecContent',
            's3Location' => [
                'bucket' => '<string>',
                'bundleType' => 'tar|tgz|zip|YAML|JSON',
                'eTag' => '<string>',
                'key' => '<string>',
                'version' => '<string>',
            ],
            'string' => [
                'content' => '<string>',
                'sha256' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

InvalidSortByException:

The column name to sort by is either not present or was specified in an invalid format.

InvalidSortOrderException:

The sort order was specified in an invalid format.

InvalidBucketNameFilterException:

The bucket name either doesn't exist or was specified in an invalid format.

InvalidKeyPrefixFilterException:

The specified key prefix filter was specified in an invalid format.

BucketNameFilterRequiredException:

A bucket name is required, but was not provided.

InvalidDeployedStateFilterException:

The deployed state filter was specified in an invalid format.

InvalidNextTokenException:

The next token was specified in an invalid format.

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listApplications([
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'applications' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidNextTokenException:

The next token was specified in an invalid format.

ListDeploymentConfigs

$result = $client->listDeploymentConfigs([/* ... */]);
$promise = $client->listDeploymentConfigsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDeploymentConfigs([
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'deploymentConfigsList' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidNextTokenException:

The next token was specified in an invalid format.

ListDeploymentGroups

$result = $client->listDeploymentGroups([/* ... */]);
$promise = $client->listDeploymentGroupsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDeploymentGroups([
    'applicationName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'applicationName' => '<string>',
    'deploymentGroups' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

InvalidNextTokenException:

The next token was specified in an invalid format.

ListDeploymentInstances

$result = $client->listDeploymentInstances([/* ... */]);
$promise = $client->listDeploymentInstancesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listDeploymentInstances([
    'deploymentId' => '<string>', // REQUIRED
    'instanceStatusFilter' => ['<string>', ...],
    'instanceTypeFilter' => ['<string>', ...],
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'instancesList' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

DeploymentIdRequiredException:

At least one deployment ID must be specified.

DeploymentDoesNotExistException:

The deployment with the user or Amazon Web Services account does not exist.

DeploymentNotStartedException:

The specified deployment has not started.

InvalidNextTokenException:

The next token was specified in an invalid format.

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

InvalidInstanceStatusException:

The specified instance status does not exist.

InvalidInstanceTypeException:

An invalid instance type was specified for instances in a blue/green deployment. Valid values include "Blue" for an original environment and "Green" for a replacement environment.

InvalidDeploymentInstanceTypeException:

An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.

InvalidTargetFilterNameException:

The target filter name is invalid.

InvalidComputePlatformException:

The computePlatform is invalid. The computePlatform should be Lambda, Server, or ECS.

ListDeploymentTargets

$result = $client->listDeploymentTargets([/* ... */]);
$promise = $client->listDeploymentTargetsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDeploymentTargets([
    'deploymentId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'targetFilters' => [
        '<TargetFilterName>' => ['<string>', ...],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'targetIds' => ['<string>', ...],
]

Result Details

Errors

DeploymentIdRequiredException:

At least one deployment ID must be specified.

DeploymentDoesNotExistException:

The deployment with the user or Amazon Web Services account does not exist.

DeploymentNotStartedException:

The specified deployment has not started.

InvalidNextTokenException:

The next token was specified in an invalid format.

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

InvalidInstanceStatusException:

The specified instance status does not exist.

InvalidInstanceTypeException:

An invalid instance type was specified for instances in a blue/green deployment. Valid values include "Blue" for an original environment and "Green" for a replacement environment.

InvalidDeploymentInstanceTypeException:

An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.

InvalidTargetFilterNameException:

The target filter name is invalid.

ListDeployments

$result = $client->listDeployments([/* ... */]);
$promise = $client->listDeploymentsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDeployments([
    'applicationName' => '<string>',
    'createTimeRange' => [
        'end' => <integer || string || DateTime>,
        'start' => <integer || string || DateTime>,
    ],
    'deploymentGroupName' => '<string>',
    'externalId' => '<string>',
    'includeOnlyStatuses' => ['<string>', ...],
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'deployments' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

InvalidDeploymentGroupNameException:

The deployment group name was specified in an invalid format.

DeploymentGroupDoesNotExistException:

The named deployment group with the user or Amazon Web Services account does not exist.

DeploymentGroupNameRequiredException:

The deployment group name was not specified.

InvalidTimeRangeException:

The specified time range was specified in an invalid format.

InvalidDeploymentStatusException:

The specified deployment status doesn't exist or cannot be determined.

InvalidNextTokenException:

The next token was specified in an invalid format.

InvalidExternalIdException:

The external ID was specified in an invalid format.

InvalidInputException:

The input was specified in an invalid format.

ListGitHubAccountTokenNames

$result = $client->listGitHubAccountTokenNames([/* ... */]);
$promise = $client->listGitHubAccountTokenNamesAsync([/* ... */]);

Lists the names of stored connections to GitHub accounts.

Parameter Syntax

$result = $client->listGitHubAccountTokenNames([
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'tokenNameList' => ['<string>', ...],
]

Result Details

Errors

InvalidNextTokenException:

The next token was specified in an invalid format.

ResourceValidationException:

The specified resource could not be validated.

OperationNotSupportedException:

The API used does not support the deployment.

ListOnPremisesInstances

$result = $client->listOnPremisesInstances([/* ... */]);
$promise = $client->listOnPremisesInstancesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listOnPremisesInstances([
    'nextToken' => '<string>',
    'registrationStatus' => 'Registered|Deregistered',
    'tagFilters' => [
        [
            'Key' => '<string>',
            'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'instanceNames' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidRegistrationStatusException:

The registration status was specified in an invalid format.

InvalidTagFilterException:

The tag filter was specified in an invalid format.

InvalidNextTokenException:

The next token was specified in an invalid format.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listTagsForResource([
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ArnNotSupportedException:

The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.

InvalidArnException:

The specified ARN is not in a valid format.

ResourceArnRequiredException:

The ARN of a resource is required, but was not found.

PutLifecycleEventHookExecutionStatus

$result = $client->putLifecycleEventHookExecutionStatus([/* ... */]);
$promise = $client->putLifecycleEventHookExecutionStatusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putLifecycleEventHookExecutionStatus([
    'deploymentId' => '<string>',
    'lifecycleEventHookExecutionId' => '<string>',
    'status' => 'Pending|InProgress|Succeeded|Failed|Skipped|Unknown',
]);

Parameter Details

Result Syntax

[
    'lifecycleEventHookExecutionId' => '<string>',
]

Result Details

Errors

InvalidLifecycleEventHookExecutionStatusException:

The result of a Lambda validation function that verifies a lifecycle event is invalid. It should return Succeeded or Failed.

InvalidLifecycleEventHookExecutionIdException:

A lifecycle event hook is invalid. Review the hooks section in your AppSpec file to ensure the lifecycle events and hooks functions are valid.

LifecycleEventAlreadyCompletedException:

An attempt to return the status of an already completed lifecycle event occurred.

DeploymentIdRequiredException:

At least one deployment ID must be specified.

DeploymentDoesNotExistException:

The deployment with the user or Amazon Web Services account does not exist.

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

UnsupportedActionForDeploymentTypeException:

A call was submitted that is not supported for the specified deployment type.

RegisterApplicationRevision

$result = $client->registerApplicationRevision([/* ... */]);
$promise = $client->registerApplicationRevisionAsync([/* ... */]);

Registers with CodeDeploy a revision for the specified application.

Parameter Syntax

$result = $client->registerApplicationRevision([
    'applicationName' => '<string>', // REQUIRED
    'description' => '<string>',
    'revision' => [ // REQUIRED
        'appSpecContent' => [
            'content' => '<string>',
            'sha256' => '<string>',
        ],
        'gitHubLocation' => [
            'commitId' => '<string>',
            'repository' => '<string>',
        ],
        'revisionType' => 'S3|GitHub|String|AppSpecContent',
        's3Location' => [
            'bucket' => '<string>',
            'bundleType' => 'tar|tgz|zip|YAML|JSON',
            'eTag' => '<string>',
            'key' => '<string>',
            'version' => '<string>',
        ],
        'string' => [
            'content' => '<string>',
            'sha256' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

DescriptionTooLongException:

The description is too long.

RevisionRequiredException:

The revision ID was not specified.

InvalidRevisionException:

The revision was specified in an invalid format.

RegisterOnPremisesInstance

$result = $client->registerOnPremisesInstance([/* ... */]);
$promise = $client->registerOnPremisesInstanceAsync([/* ... */]);

Registers an on-premises instance.

Parameter Syntax

$result = $client->registerOnPremisesInstance([
    'iamSessionArn' => '<string>',
    'iamUserArn' => '<string>',
    'instanceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InstanceNameAlreadyRegisteredException:

The specified on-premises instance name is already registered.

IamArnRequiredException:

No IAM ARN was included in the request. You must use an IAM session ARN or user ARN in the request.

IamSessionArnAlreadyRegisteredException:

The request included an IAM session ARN that has already been used to register a different instance.

IamUserArnAlreadyRegisteredException:

The specified user ARN is already registered with an on-premises instance.

InstanceNameRequiredException:

An on-premises instance name was not specified.

IamUserArnRequiredException:

An user ARN was not specified.

InvalidInstanceNameException:

The on-premises instance name was specified in an invalid format.

InvalidIamSessionArnException:

The IAM session ARN was specified in an invalid format.

InvalidIamUserArnException:

The user ARN was specified in an invalid format.

MultipleIamArnsProvidedException:

Both an user ARN and an IAM session ARN were included in the request. Use only one ARN type.

RemoveTagsFromOnPremisesInstances

$result = $client->removeTagsFromOnPremisesInstances([/* ... */]);
$promise = $client->removeTagsFromOnPremisesInstancesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->removeTagsFromOnPremisesInstances([
    'instanceNames' => ['<string>', ...], // REQUIRED
    'tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InstanceNameRequiredException:

An on-premises instance name was not specified.

InvalidInstanceNameException:

The on-premises instance name was specified in an invalid format.

TagRequiredException:

A tag was not specified.

InvalidTagException:

The tag was specified in an invalid format.

TagLimitExceededException:

The maximum allowed number of tags was exceeded.

InstanceLimitExceededException:

The maximum number of allowed on-premises instances in a single call was exceeded.

InstanceNotRegisteredException:

The specified on-premises instance is not registered.

SkipWaitTimeForInstanceTermination

$result = $client->skipWaitTimeForInstanceTermination([/* ... */]);
$promise = $client->skipWaitTimeForInstanceTerminationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->skipWaitTimeForInstanceTermination([
    'deploymentId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DeploymentIdRequiredException:

At least one deployment ID must be specified.

DeploymentDoesNotExistException:

The deployment with the user or Amazon Web Services account does not exist.

DeploymentAlreadyCompletedException:

The deployment is already complete.

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

DeploymentNotStartedException:

The specified deployment has not started.

UnsupportedActionForDeploymentTypeException:

A call was submitted that is not supported for the specified deployment type.

StopDeployment

$result = $client->stopDeployment([/* ... */]);
$promise = $client->stopDeploymentAsync([/* ... */]);

Attempts to stop an ongoing deployment.

Parameter Syntax

$result = $client->stopDeployment([
    'autoRollbackEnabled' => true || false,
    'deploymentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => 'Pending|Succeeded',
    'statusMessage' => '<string>',
]

Result Details

Errors

DeploymentIdRequiredException:

At least one deployment ID must be specified.

DeploymentDoesNotExistException:

The deployment with the user or Amazon Web Services account does not exist.

DeploymentGroupDoesNotExistException:

The named deployment group with the user or Amazon Web Services account does not exist.

DeploymentAlreadyCompletedException:

The deployment is already complete.

InvalidDeploymentIdException:

At least one of the deployment IDs was specified in an invalid format.

UnsupportedActionForDeploymentTypeException:

A call was submitted that is not supported for the specified deployment type.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceArnRequiredException:

The ARN of a resource is required, but was not found.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

DeploymentGroupDoesNotExistException:

The named deployment group with the user or Amazon Web Services account does not exist.

DeploymentConfigDoesNotExistException:

The deployment configuration does not exist with the user or Amazon Web Services account.

TagRequiredException:

A tag was not specified.

InvalidTagsToAddException:

The specified tags are not valid.

ArnNotSupportedException:

The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.

InvalidArnException:

The specified ARN is not in a valid format.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceArnRequiredException:

The ARN of a resource is required, but was not found.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

DeploymentGroupDoesNotExistException:

The named deployment group with the user or Amazon Web Services account does not exist.

DeploymentConfigDoesNotExistException:

The deployment configuration does not exist with the user or Amazon Web Services account.

TagRequiredException:

A tag was not specified.

InvalidTagsToAddException:

The specified tags are not valid.

ArnNotSupportedException:

The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.

InvalidArnException:

The specified ARN is not in a valid format.

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

Changes the name of an application.

Parameter Syntax

$result = $client->updateApplication([
    'applicationName' => '<string>',
    'newApplicationName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

ApplicationAlreadyExistsException:

An application with the specified name with the user or Amazon Web Services account already exists.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

UpdateDeploymentGroup

$result = $client->updateDeploymentGroup([/* ... */]);
$promise = $client->updateDeploymentGroupAsync([/* ... */]);

Changes information about a deployment group.

Parameter Syntax

$result = $client->updateDeploymentGroup([
    'alarmConfiguration' => [
        'alarms' => [
            [
                'name' => '<string>',
            ],
            // ...
        ],
        'enabled' => true || false,
        'ignorePollAlarmFailure' => true || false,
    ],
    'applicationName' => '<string>', // REQUIRED
    'autoRollbackConfiguration' => [
        'enabled' => true || false,
        'events' => ['<string>', ...],
    ],
    'autoScalingGroups' => ['<string>', ...],
    'blueGreenDeploymentConfiguration' => [
        'deploymentReadyOption' => [
            'actionOnTimeout' => 'CONTINUE_DEPLOYMENT|STOP_DEPLOYMENT',
            'waitTimeInMinutes' => <integer>,
        ],
        'greenFleetProvisioningOption' => [
            'action' => 'DISCOVER_EXISTING|COPY_AUTO_SCALING_GROUP',
        ],
        'terminateBlueInstancesOnDeploymentSuccess' => [
            'action' => 'TERMINATE|KEEP_ALIVE',
            'terminationWaitTimeInMinutes' => <integer>,
        ],
    ],
    'currentDeploymentGroupName' => '<string>', // REQUIRED
    'deploymentConfigName' => '<string>',
    'deploymentStyle' => [
        'deploymentOption' => 'WITH_TRAFFIC_CONTROL|WITHOUT_TRAFFIC_CONTROL',
        'deploymentType' => 'IN_PLACE|BLUE_GREEN',
    ],
    'ec2TagFilters' => [
        [
            'Key' => '<string>',
            'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
            'Value' => '<string>',
        ],
        // ...
    ],
    'ec2TagSet' => [
        'ec2TagSetList' => [
            [
                [
                    'Key' => '<string>',
                    'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                    'Value' => '<string>',
                ],
                // ...
            ],
            // ...
        ],
    ],
    'ecsServices' => [
        [
            'clusterName' => '<string>',
            'serviceName' => '<string>',
        ],
        // ...
    ],
    'loadBalancerInfo' => [
        'elbInfoList' => [
            [
                'name' => '<string>',
            ],
            // ...
        ],
        'targetGroupInfoList' => [
            [
                'name' => '<string>',
            ],
            // ...
        ],
        'targetGroupPairInfoList' => [
            [
                'prodTrafficRoute' => [
                    'listenerArns' => ['<string>', ...],
                ],
                'targetGroups' => [
                    [
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'testTrafficRoute' => [
                    'listenerArns' => ['<string>', ...],
                ],
            ],
            // ...
        ],
    ],
    'newDeploymentGroupName' => '<string>',
    'onPremisesInstanceTagFilters' => [
        [
            'Key' => '<string>',
            'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
            'Value' => '<string>',
        ],
        // ...
    ],
    'onPremisesTagSet' => [
        'onPremisesTagSetList' => [
            [
                [
                    'Key' => '<string>',
                    'Type' => 'KEY_ONLY|VALUE_ONLY|KEY_AND_VALUE',
                    'Value' => '<string>',
                ],
                // ...
            ],
            // ...
        ],
    ],
    'outdatedInstancesStrategy' => 'UPDATE|IGNORE',
    'serviceRoleArn' => '<string>',
    'terminationHookEnabled' => true || false,
    'triggerConfigurations' => [
        [
            'triggerEvents' => ['<string>', ...],
            'triggerName' => '<string>',
            'triggerTargetArn' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'hooksNotCleanedUp' => [
        [
            'hook' => '<string>',
            'name' => '<string>',
            'terminationHook' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ApplicationNameRequiredException:

The minimum number of required application names was not specified.

InvalidApplicationNameException:

The application name was specified in an invalid format.

ApplicationDoesNotExistException:

The application does not exist with the user or Amazon Web Services account.

InvalidDeploymentGroupNameException:

The deployment group name was specified in an invalid format.

DeploymentGroupAlreadyExistsException:

A deployment group with the specified name with the user or Amazon Web Services account already exists.

DeploymentGroupNameRequiredException:

The deployment group name was not specified.

DeploymentGroupDoesNotExistException:

The named deployment group with the user or Amazon Web Services account does not exist.

InvalidEC2TagException:

The tag was specified in an invalid format.

InvalidTagException:

The tag was specified in an invalid format.

InvalidAutoScalingGroupException:

The Auto Scaling group was specified in an invalid format or does not exist.

InvalidDeploymentConfigNameException:

The deployment configuration name was specified in an invalid format.

DeploymentConfigDoesNotExistException:

The deployment configuration does not exist with the user or Amazon Web Services account.

InvalidRoleException:

The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.

LifecycleHookLimitExceededException:

The limit for lifecycle hooks was exceeded.

InvalidTriggerConfigException:

The trigger was specified in an invalid format.

TriggerTargetsLimitExceededException:

The maximum allowed number of triggers was exceeded.

InvalidAlarmConfigException:

The format of the alarm configuration is invalid. Possible causes include:

• The alarm list is null.

• The alarm object is null.

• The alarm name is empty or null or exceeds the limit of 255 characters.

• Two alarms with the same name have been specified.

• The alarm configuration is enabled, but the alarm list is empty.

AlarmsLimitExceededException:

The maximum number of alarms for a deployment group (10) was exceeded.

InvalidAutoRollbackConfigException:

The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.

InvalidLoadBalancerInfoException:

An invalid load balancer name, or no load balancer name, was specified.

InvalidDeploymentStyleException:

An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN." Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL."

InvalidBlueGreenDeploymentConfigurationException:

The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.

InvalidEC2TagCombinationException:

A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.

InvalidOnPremisesTagCombinationException:

A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.

TagSetListLimitExceededException:

The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.

InvalidInputException:

The input was specified in an invalid format.

ThrottlingException:

An API function was called too frequently.

InvalidECSServiceException:

The Amazon ECS service identifier is not valid.

InvalidTargetGroupPairException:

A target group pair associated with this deployment is not valid.

ECSServiceMappingLimitExceededException:

The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group.

InvalidTrafficRoutingConfigurationException:

The configuration that specifies how traffic is routed during a deployment is invalid.