amazonka-codedeploy-1.1.0: Amazon CodeDeploy SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CodeDeploy

Contents

Description

AWS CodeDeploy Overview

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

Using the APIs

You can use the AWS CodeDeploy APIs to work with the following items:

  • Applications are unique identifiers that AWS CodeDeploy uses to ensure that the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments.

    You can use the AWS CodeDeploy APIs to create, delete, get, list, and update applications.

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

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

  • Deployment groups are groups of instances to which application revisions can be deployed.

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

  • Instances represent Amazon EC2 instances to which application revisions are deployed. Instances are identified by their Amazon EC2 tags or Auto Scaling group names. Instances belong to deployment groups.

    You can use the AWS CodeDeploy APIs to get and list instances.

  • Deployments represent the process of deploying revisions to instances.

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

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

    You can use the AWS CodeDeploy APIs to get, list, and register application revisions.

See: AWS API Reference

Synopsis

Service

data CodeDeploy Source

Version 2014-10-06 of the Amazon CodeDeploy SDK.

Instances

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CodeDeploy.

InvalidTimeRangeException

_InvalidTimeRangeException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified time range was specified in an invalid format.

InvalidTagException

_InvalidTagException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified tag was specified in an invalid format.

InstanceNameAlreadyRegisteredException

_InstanceNameAlreadyRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified on-premises instance name is already registered.

InvalidIAMUserARNException

_InvalidIAMUserARNException :: AsError a => Getting (First ServiceError) a ServiceError Source

The IAM user ARN was specified in an invalid format.

IAMUserARNRequiredException

_IAMUserARNRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

An IAM user ARN was not specified.

InvalidDeploymentGroupNameException

_InvalidDeploymentGroupNameException :: AsError a => Getting (First ServiceError) a ServiceError Source

The deployment group name was specified in an invalid format.

DescriptionTooLongException

_DescriptionTooLongException :: AsError a => Getting (First ServiceError) a ServiceError Source

The description that was provided is too long.

DeploymentConfigAlreadyExistsException

_DeploymentConfigAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source

A deployment configuration with the specified name already exists with the applicable IAM user or AWS account.

DeploymentConfigLimitExceededException

_DeploymentConfigLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

The deployment configurations limit was exceeded.

InvalidRoleException

_InvalidRoleException :: AsError a => Getting (First ServiceError) a ServiceError Source

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 Auto Scaling.

DeploymentNotStartedException

_DeploymentNotStartedException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified deployment has not started.

RoleRequiredException

_RoleRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

The role ID was not specified.

IAMUserARNAlreadyRegisteredException

_IAMUserARNAlreadyRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

DeploymentLimitExceededException

_DeploymentLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

The number of allowed deployments was exceeded.

InstanceLimitExceededException

_InstanceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

InvalidAutoScalingGroupException

_InvalidAutoScalingGroupException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

InvalidApplicationNameException

_InvalidApplicationNameException :: AsError a => Getting (First ServiceError) a ServiceError Source

The application name was specified in an invalid format.

InvalidDeployedStateFilterException

_InvalidDeployedStateFilterException :: AsError a => Getting (First ServiceError) a ServiceError Source

The deployed state filter was specified in an invalid format.

InvalidMinimumHealthyHostValueException

_InvalidMinimumHealthyHostValueException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

ApplicationDoesNotExistException

_ApplicationDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source

The application does not exist with the applicable IAM user or AWS account.

InvalidTagFilterException

_InvalidTagFilterException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified tag filter was specified in an invalid format.

TagRequiredException

_TagRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

A tag was not specified.

RevisionDoesNotExistException

_RevisionDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source

The named revision does not exist with the applicable IAM user or AWS account.

DeploymentGroupNameRequiredException

_DeploymentGroupNameRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

The deployment group name was not specified.

InvalidBucketNameFilterException

_InvalidBucketNameFilterException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

DeploymentConfigDoesNotExistException

_DeploymentConfigDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source

The deployment configuration does not exist with the applicable IAM user or AWS account.

InvalidSortByException

_InvalidSortByException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

BucketNameFilterRequiredException

_BucketNameFilterRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

A bucket name is required but was not provided.

DeploymentGroupLimitExceededException

_DeploymentGroupLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

The deployment groups limit was exceeded.

DeploymentGroupAlreadyExistsException

_DeploymentGroupAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source

A deployment group with the specified name already exists with the applicable IAM user or AWS account.

InvalidDeploymentIdException

_InvalidDeploymentIdException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

DeploymentGroupDoesNotExistException

_DeploymentGroupDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source

The named deployment group does not exist with the applicable IAM user or AWS account.

DeploymentIdRequiredException

_DeploymentIdRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

At least one deployment ID must be specified.

InstanceIdRequiredException

_InstanceIdRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

The instance ID was not specified.

DeploymentConfigNameRequiredException

_DeploymentConfigNameRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

The deployment configuration name was not specified.

InvalidDeploymentConfigNameException

_InvalidDeploymentConfigNameException :: AsError a => Getting (First ServiceError) a ServiceError Source

The deployment configuration name was specified in an invalid format.

InvalidSortOrderException

_InvalidSortOrderException :: AsError a => Getting (First ServiceError) a ServiceError Source

The sort order was specified in an invalid format.

InvalidNextTokenException

_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source

The next token was specified in an invalid format.

InvalidRevisionException

_InvalidRevisionException :: AsError a => Getting (First ServiceError) a ServiceError Source

The revision was specified in an invalid format.

DeploymentAlreadyCompletedException

_DeploymentAlreadyCompletedException :: AsError a => Getting (First ServiceError) a ServiceError Source

The deployment is already completed.

RevisionRequiredException

_RevisionRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

The revision ID was not specified.

InstanceDoesNotExistException

_InstanceDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified instance does not exist in the deployment group.

DeploymentDoesNotExistException

_DeploymentDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source

The deployment does not exist with the applicable IAM user or AWS account.

InstanceNameRequiredException

_InstanceNameRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

An on-premises instance name was not specified.

DeploymentConfigInUseException

_DeploymentConfigInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source

The deployment configuration is still in use.

InvalidEC2TagException

_InvalidEC2TagException :: AsError a => Getting (First ServiceError) a ServiceError Source

The tag was specified in an invalid format.

InvalidInstanceNameException

_InvalidInstanceNameException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

InvalidDeploymentStatusException

_InvalidDeploymentStatusException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

InvalidRegistrationStatusException

_InvalidRegistrationStatusException :: AsError a => Getting (First ServiceError) a ServiceError Source

The registration status was specified in an invalid format.

TagLimitExceededException

_TagLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

The maximum allowed number of tags was exceeded.

InstanceNotRegisteredException

_InstanceNotRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified on-premises instance is not registered.

ApplicationLimitExceededException

_ApplicationLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

More applications were attempted to be created than were allowed.

InvalidOperationException

_InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source

An invalid operation was detected.

ApplicationAlreadyExistsException

_ApplicationAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source

An application with the specified name already exists with the applicable IAM user or AWS account.

InvalidInstanceStatusException

_InvalidInstanceStatusException :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified instance status does not exist.

ApplicationNameRequiredException

_ApplicationNameRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source

The minimum number of required application names was not specified.

InvalidKeyPrefixFilterException

_InvalidKeyPrefixFilterException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

RemoveTagsFromOnPremisesInstances

module Network.AWS.CodeDeploy.RemoveTagsFromOnPremisesInstances

GetDeployment

module Network.AWS.CodeDeploy.GetDeployment

CreateDeploymentConfig

module Network.AWS.CodeDeploy.CreateDeploymentConfig

UpdateDeploymentGroup

module Network.AWS.CodeDeploy.UpdateDeploymentGroup

DeleteDeploymentGroup

module Network.AWS.CodeDeploy.DeleteDeploymentGroup

ListOnPremisesInstances

module Network.AWS.CodeDeploy.ListOnPremisesInstances

GetApplicationRevision

module Network.AWS.CodeDeploy.GetApplicationRevision

DeleteDeploymentConfig

module Network.AWS.CodeDeploy.DeleteDeploymentConfig

GetDeploymentConfig

module Network.AWS.CodeDeploy.GetDeploymentConfig

CreateDeployment

module Network.AWS.CodeDeploy.CreateDeployment

GetOnPremisesInstance

module Network.AWS.CodeDeploy.GetOnPremisesInstance

BatchGetDeployments

module Network.AWS.CodeDeploy.BatchGetDeployments

RegisterApplicationRevision

module Network.AWS.CodeDeploy.RegisterApplicationRevision

DeleteApplication

module Network.AWS.CodeDeploy.DeleteApplication

UpdateApplication

module Network.AWS.CodeDeploy.UpdateApplication

BatchGetApplications

module Network.AWS.CodeDeploy.BatchGetApplications

CreateApplication

module Network.AWS.CodeDeploy.CreateApplication

DeregisterOnPremisesInstance

module Network.AWS.CodeDeploy.DeregisterOnPremisesInstance

GetDeploymentInstance

module Network.AWS.CodeDeploy.GetDeploymentInstance

StopDeployment

module Network.AWS.CodeDeploy.StopDeployment

GetApplication

module Network.AWS.CodeDeploy.GetApplication

ListDeploymentGroups

module Network.AWS.CodeDeploy.ListDeploymentGroups

RegisterOnPremisesInstance

module Network.AWS.CodeDeploy.RegisterOnPremisesInstance

BatchGetOnPremisesInstances

module Network.AWS.CodeDeploy.BatchGetOnPremisesInstances

ListDeploymentConfigs

module Network.AWS.CodeDeploy.ListDeploymentConfigs

CreateDeploymentGroup

module Network.AWS.CodeDeploy.CreateDeploymentGroup

GetDeploymentGroup

module Network.AWS.CodeDeploy.GetDeploymentGroup

ListDeployments

module Network.AWS.CodeDeploy.ListDeployments

ListApplicationRevisions

module Network.AWS.CodeDeploy.ListApplicationRevisions

ListApplications

module Network.AWS.CodeDeploy.ListApplications

AddTagsToOnPremisesInstances

module Network.AWS.CodeDeploy.AddTagsToOnPremisesInstances

ListDeploymentInstances

module Network.AWS.CodeDeploy.ListDeploymentInstances

Types

ApplicationRevisionSortBy

data ApplicationRevisionSortBy Source

Constructors

FirstUsedTime 
LastUsedTime 
RegisterTime 

Instances

BundleType

data BundleType Source

Constructors

TAR 
TGZ 
Zip 

Instances

DeployErrorCode

data DeployErrorCode Source

Constructors

ApplicationMissing 
DeploymentGroupMissing 
HealthConstraints 
HealthConstraintsInvalid 
IAMRoleMissing 
IAMRolePermissions 
InternalError 
NoEC2Subscription 
NoInstances 
OverMaxInstances 
RevisionMissing 
Throttled 
Timeout 

Instances

DeploymentCreator

data DeploymentCreator Source

Constructors

Autoscaling 
User 

Instances

DeploymentStatus

data DeploymentStatus Source

Constructors

Created 
Failed 
InProgress 
Queued 
Stopped 
Succeeded 

Instances

EC2TagFilterType

data EC2TagFilterType Source

Constructors

KeyAndValue 
KeyOnly 
ValueOnly 

Instances

InstanceStatus

data InstanceStatus Source

Constructors

ISFailed 
ISInProgress 
ISPending 
ISSkipped 
ISSucceeded 
ISUnknown 

Instances

LifecycleErrorCode

data LifecycleErrorCode Source

Constructors

ScriptFailed 
ScriptMissing 
ScriptNotExecutable 
ScriptTimedOut 
Success 
UnknownError 

Instances

LifecycleEventStatus

data LifecycleEventStatus Source

Constructors

LESFailed 
LESInProgress 
LESPending 
LESSkipped 
LESSucceeded 
LESUnknown 

Instances

ListStateFilterAction

data ListStateFilterAction Source

Constructors

Exclude 
Ignore 
Include 

Instances

MinimumHealthyHostsType

data MinimumHealthyHostsType Source

Constructors

FleetPercent 
HostCount 

Instances

RegistrationStatus

data RegistrationStatus Source

Constructors

Deregistered 
Registered 

Instances

RevisionLocationType

data RevisionLocationType Source

Constructors

GitHub 
S3 

Instances

SortOrder

data SortOrder Source

Constructors

Ascending 
Descending 

Instances

StopStatus

data StopStatus Source

Constructors

SSPending 
SSSucceeded 

Instances

TagFilterType

data TagFilterType Source

Constructors

TFTKeyAndValue 
TFTKeyOnly 
TFTValueOnly 

Instances

ApplicationInfo

data ApplicationInfo Source

Information about an application.

See: applicationInfo smart constructor.

Instances

applicationInfo :: ApplicationInfo Source

Creates a value of ApplicationInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aiLinkedToGitHub :: Lens' ApplicationInfo (Maybe Bool) Source

True if the user has authenticated with GitHub for the specified application; otherwise, false.

aiApplicationId :: Lens' ApplicationInfo (Maybe Text) Source

The application ID.

aiApplicationName :: Lens' ApplicationInfo (Maybe Text) Source

The application name.

aiCreateTime :: Lens' ApplicationInfo (Maybe UTCTime) Source

The time that the application was created.

AutoScalingGroup

data AutoScalingGroup Source

Information about an Auto Scaling group.

See: autoScalingGroup smart constructor.

Instances

autoScalingGroup :: AutoScalingGroup Source

Creates a value of AutoScalingGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

asgHook :: Lens' AutoScalingGroup (Maybe Text) Source

An Auto Scaling lifecycle event hook name.

asgName :: Lens' AutoScalingGroup (Maybe Text) Source

The Auto Scaling group name.

DeploymentConfigInfo

data DeploymentConfigInfo Source

Information about a deployment configuration.

See: deploymentConfigInfo smart constructor.

Instances

deploymentConfigInfo :: DeploymentConfigInfo Source

Creates a value of DeploymentConfigInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dciDeploymentConfigName :: Lens' DeploymentConfigInfo (Maybe Text) Source

The deployment configuration name.

dciMinimumHealthyHosts :: Lens' DeploymentConfigInfo (Maybe MinimumHealthyHosts) Source

Information about the number or percentage of minimum healthy instances.

dciDeploymentConfigId :: Lens' DeploymentConfigInfo (Maybe Text) Source

The deployment configuration ID.

dciCreateTime :: Lens' DeploymentConfigInfo (Maybe UTCTime) Source

The time that the deployment configuration was created.

DeploymentGroupInfo

data DeploymentGroupInfo Source

Information about a deployment group.

See: deploymentGroupInfo smart constructor.

Instances

deploymentGroupInfo :: DeploymentGroupInfo Source

Creates a value of DeploymentGroupInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dgiServiceRoleARN :: Lens' DeploymentGroupInfo (Maybe Text) Source

A service role ARN.

dgiDeploymentConfigName :: Lens' DeploymentGroupInfo (Maybe Text) Source

The deployment configuration name.

dgiTargetRevision :: Lens' DeploymentGroupInfo (Maybe RevisionLocation) Source

Information about the deployment group's target revision, including the revision's type and its location.

dgiEc2TagFilters :: Lens' DeploymentGroupInfo [EC2TagFilter] Source

The Amazon EC2 tags to filter on.

dgiOnPremisesInstanceTagFilters :: Lens' DeploymentGroupInfo [TagFilter] Source

The on-premises instance tags to filter on.

dgiApplicationName :: Lens' DeploymentGroupInfo (Maybe Text) Source

The application name.

dgiDeploymentGroupId :: Lens' DeploymentGroupInfo (Maybe Text) Source

The deployment group ID.

dgiAutoScalingGroups :: Lens' DeploymentGroupInfo [AutoScalingGroup] Source

A list of associated Auto Scaling groups.

dgiDeploymentGroupName :: Lens' DeploymentGroupInfo (Maybe Text) Source

The deployment group name.

DeploymentInfo

data DeploymentInfo Source

Information about a deployment.

See: deploymentInfo smart constructor.

Instances

deploymentInfo :: DeploymentInfo Source

Creates a value of DeploymentInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

diDeploymentId :: Lens' DeploymentInfo (Maybe Text) Source

The deployment ID.

diCreator :: Lens' DeploymentInfo (Maybe DeploymentCreator) Source

How the deployment was created:

  • user: A user created the deployment.
  • autoscaling: Auto Scaling created the deployment.

diStatus :: Lens' DeploymentInfo (Maybe DeploymentStatus) Source

The current state of the deployment as a whole.

diDeploymentConfigName :: Lens' DeploymentInfo (Maybe Text) Source

The deployment configuration name.

diStartTime :: Lens' DeploymentInfo (Maybe UTCTime) Source

A timestamp indicating when the deployment began deploying to the deployment group.

Note that in some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of various back-end servers that participate in the overall deployment process.

diCompleteTime :: Lens' DeploymentInfo (Maybe UTCTime) Source

A timestamp indicating when the deployment was completed.

diErrorInformation :: Lens' DeploymentInfo (Maybe ErrorInformation) Source

Information about any error associated with this deployment.

diDeploymentOverview :: Lens' DeploymentInfo (Maybe DeploymentOverview) Source

A summary of the deployment status of the instances in the deployment.

diApplicationName :: Lens' DeploymentInfo (Maybe Text) Source

The application name.

diRevision :: Lens' DeploymentInfo (Maybe RevisionLocation) Source

Information about the location of application artifacts that are stored and the service to retrieve them from.

diDescription :: Lens' DeploymentInfo (Maybe Text) Source

A comment about the deployment.

diIgnoreApplicationStopFailures :: Lens' DeploymentInfo (Maybe Bool) Source

If true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.

If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.

diDeploymentGroupName :: Lens' DeploymentInfo (Maybe Text) Source

The deployment group name.

diCreateTime :: Lens' DeploymentInfo (Maybe UTCTime) Source

A timestamp indicating when the deployment was created.

DeploymentOverview

data DeploymentOverview Source

Information about the deployment status of the instances in the deployment.

See: deploymentOverview smart constructor.

Instances

deploymentOverview :: DeploymentOverview Source

Creates a value of DeploymentOverview with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

doPending :: Lens' DeploymentOverview (Maybe Integer) Source

The number of instances that are pending in the deployment.

doSkipped :: Lens' DeploymentOverview (Maybe Integer) Source

The number of instances that have been skipped in the deployment.

doInProgress :: Lens' DeploymentOverview (Maybe Integer) Source

The number of instances that are in progress in the deployment.

doSucceeded :: Lens' DeploymentOverview (Maybe Integer) Source

The number of instances that have succeeded in the deployment.

doFailed :: Lens' DeploymentOverview (Maybe Integer) Source

The number of instances that have failed in the deployment.

Diagnostics

data Diagnostics Source

Diagnostic information about executable scripts that are part of a deployment.

See: diagnostics smart constructor.

Instances

diagnostics :: Diagnostics Source

Creates a value of Diagnostics with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dLogTail :: Lens' Diagnostics (Maybe Text) Source

The last portion of the associated diagnostic log.

dErrorCode :: Lens' Diagnostics (Maybe LifecycleErrorCode) Source

The associated error code:

  • Success: The specified script ran.
  • ScriptMissing: The specified script was not found in the specified location.
  • ScriptNotExecutable: The specified script is not a recognized executable file type.
  • ScriptTimedOut: The specified script did not finish running in the specified time period.
  • ScriptFailed: The specified script failed to run as expected.
  • UnknownError: The specified script did not run for an unknown reason.

dScriptName :: Lens' Diagnostics (Maybe Text) Source

The name of the script.

dMessage :: Lens' Diagnostics (Maybe Text) Source

The message associated with the error.

EC2TagFilter

data EC2TagFilter Source

Information about a tag filter.

See: ec2TagFilter smart constructor.

Instances

ec2TagFilter :: EC2TagFilter Source

Creates a value of EC2TagFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

etfValue :: Lens' EC2TagFilter (Maybe Text) Source

The tag filter value.

etfKey :: Lens' EC2TagFilter (Maybe Text) Source

The tag filter key.

etfType :: Lens' EC2TagFilter (Maybe EC2TagFilterType) Source

The tag filter type:

  • KEY_ONLY: Key only.
  • VALUE_ONLY: Value only.
  • KEY_AND_VALUE: Key and value.

ErrorInformation

data ErrorInformation Source

Information about a deployment error.

See: errorInformation smart constructor.

Instances

errorInformation :: ErrorInformation Source

Creates a value of ErrorInformation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eiCode :: Lens' ErrorInformation (Maybe DeployErrorCode) Source

The error code:

  • APPLICATION_MISSING: The application was missing. Note that this error code will most likely be raised if the application is deleted after the deployment is created but before it starts.
  • DEPLOYMENT_GROUP_MISSING: The deployment group was missing. Note that this error code will most likely be raised if the deployment group is deleted after the deployment is created but before it starts.
  • HEALTH_CONSTRAINTS: The deployment failed on too many instances to be able to successfully deploy within the specified instance health constraints.
  • HEALTH_CONSTRAINTS_INVALID: The revision can never successfully deploy within the instance health constraints as specified.
  • IAM_ROLE_MISSING: The service role cannot be accessed.
  • IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.
  • INTERNAL_ERROR: There was an internal error.
  • NO_EC2_SUBSCRIPTION: The calling account is not subscribed to the Amazon EC2 service.
  • NO_INSTANCES: No instances were specified, or no instances can be found.
  • OVER_MAX_INSTANCES: The maximum number of instances was exceeded.
  • THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more AWS services.
  • TIMEOUT: The deployment has timed out.
  • REVISION_MISSING: The revision ID was missing. Note that this error code will most likely be raised if the revision is deleted after the deployment is created but before it starts.

eiMessage :: Lens' ErrorInformation (Maybe Text) Source

An accompanying error message.

GenericRevisionInfo

data GenericRevisionInfo Source

Information about an application revision.

See: genericRevisionInfo smart constructor.

Instances

genericRevisionInfo :: GenericRevisionInfo Source

Creates a value of GenericRevisionInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

griRegisterTime :: Lens' GenericRevisionInfo (Maybe UTCTime) Source

When the revision was registered with AWS CodeDeploy.

griFirstUsedTime :: Lens' GenericRevisionInfo (Maybe UTCTime) Source

When the revision was first used by AWS CodeDeploy.

griDeploymentGroups :: Lens' GenericRevisionInfo [Text] Source

A list of deployment groups that use this revision.

griLastUsedTime :: Lens' GenericRevisionInfo (Maybe UTCTime) Source

When the revision was last used by AWS CodeDeploy.

griDescription :: Lens' GenericRevisionInfo (Maybe Text) Source

A comment about the revision.

GitHubLocation

data GitHubLocation Source

Information about the location of application artifacts that are stored in GitHub.

See: gitHubLocation smart constructor.

Instances

gitHubLocation :: GitHubLocation Source

Creates a value of GitHubLocation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ghlCommitId :: Lens' GitHubLocation (Maybe Text) Source

The SHA1 commit ID of the GitHub commit that references the that represents the bundled artifacts for the application revision.

ghlRepository :: Lens' GitHubLocation (Maybe Text) Source

The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.

Specified as account/repository.

InstanceInfo

data InstanceInfo Source

Information about an on-premises instance.

See: instanceInfo smart constructor.

Instances

instanceInfo :: InstanceInfo Source

Creates a value of InstanceInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

iiInstanceARN :: Lens' InstanceInfo (Maybe Text) Source

The ARN of the on-premises instance.

iiRegisterTime :: Lens' InstanceInfo (Maybe UTCTime) Source

The time that the on-premises instance was registered.

iiDeregisterTime :: Lens' InstanceInfo (Maybe UTCTime) Source

If the on-premises instance was deregistered, the time that the on-premises instance was deregistered.

iiIamUserARN :: Lens' InstanceInfo (Maybe Text) Source

The IAM user ARN associated with the on-premises instance.

iiInstanceName :: Lens' InstanceInfo (Maybe Text) Source

The name of the on-premises instance.

iiTags :: Lens' InstanceInfo [Tag] Source

The tags that are currently associated with the on-premises instance.

InstanceSummary

data InstanceSummary Source

Information about an instance in a deployment.

See: instanceSummary smart constructor.

Instances

instanceSummary :: InstanceSummary Source

Creates a value of InstanceSummary with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

isInstanceId :: Lens' InstanceSummary (Maybe Text) Source

The instance ID.

isDeploymentId :: Lens' InstanceSummary (Maybe Text) Source

The deployment ID.

isStatus :: Lens' InstanceSummary (Maybe InstanceStatus) Source

The deployment status for this instance:

  • Pending: The deployment is pending for this instance.
  • In Progress: The deployment is in progress for this instance.
  • Succeeded: The deployment has succeeded for this instance.
  • Failed: The deployment has failed for this instance.
  • Skipped: The deployment has been skipped for this instance.
  • Unknown: The deployment status is unknown for this instance.

isLastUpdatedAt :: Lens' InstanceSummary (Maybe UTCTime) Source

A timestamp indicating when the instance information was last updated.

isLifecycleEvents :: Lens' InstanceSummary [LifecycleEvent] Source

A list of lifecycle events for this instance.

LifecycleEvent

data LifecycleEvent Source

Information about a deployment lifecycle event.

See: lifecycleEvent smart constructor.

Instances

lifecycleEvent :: LifecycleEvent Source

Creates a value of LifecycleEvent with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

leStatus :: Lens' LifecycleEvent (Maybe LifecycleEventStatus) Source

The deployment lifecycle event status:

  • Pending: The deployment lifecycle event is pending.
  • InProgress: The deployment lifecycle event is in progress.
  • Succeeded: The deployment lifecycle event has succeeded.
  • Failed: The deployment lifecycle event has failed.
  • Skipped: The deployment lifecycle event has been skipped.
  • Unknown: The deployment lifecycle event is unknown.

leStartTime :: Lens' LifecycleEvent (Maybe UTCTime) Source

A timestamp indicating when the deployment lifecycle event started.

leLifecycleEventName :: Lens' LifecycleEvent (Maybe Text) Source

The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.

leDiagnostics :: Lens' LifecycleEvent (Maybe Diagnostics) Source

Diagnostic information about the deployment lifecycle event.

leEndTime :: Lens' LifecycleEvent (Maybe UTCTime) Source

A timestamp indicating when the deployment lifecycle event ended.

MinimumHealthyHosts

data MinimumHealthyHosts Source

Information about minimum healthy instances.

See: minimumHealthyHosts smart constructor.

Instances

minimumHealthyHosts :: MinimumHealthyHosts Source

Creates a value of MinimumHealthyHosts with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mhhValue :: Lens' MinimumHealthyHosts (Maybe Int) Source

The minimum healthy instances value.

mhhType :: Lens' MinimumHealthyHosts (Maybe MinimumHealthyHostsType) Source

The minimum healthy instances type:

  • HOST_COUNT: The minimum number of healthy instances, as an absolute value.
  • FLEET_PERCENT: The minimum number of healthy instances, as a percentage of the total number of instances in the deployment.

For example, for 9 instances, if a HOST_COUNT of 6 is specified, deploy to up to 3 instances at a time. The deployment succeeds if 6 or more instances are successfully deployed to; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to 5 instances at a time. The deployment succeeds if 4 or more instances are successfully deployed to; otherwise, the deployment fails.

In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return a minimum healthy instances type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instances at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.)

RevisionLocation

data RevisionLocation Source

Information about an application revision's location.

See: revisionLocation smart constructor.

Instances

revisionLocation :: RevisionLocation Source

Creates a value of RevisionLocation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rlRevisionType :: Lens' RevisionLocation (Maybe RevisionLocationType) Source

The application revision's type:

  • S3: An application revision stored in Amazon S3.
  • GitHub: An application revision stored in GitHub.

rlS3Location :: Lens' RevisionLocation (Maybe S3Location) Source

Undocumented member.

rlGitHubLocation :: Lens' RevisionLocation (Maybe GitHubLocation) Source

Undocumented member.

S3Location

data S3Location Source

Information about the location of application artifacts that are stored in Amazon S3.

See: s3Location smart constructor.

Instances

s3Location :: S3Location Source

Creates a value of S3Location with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

slBundleType :: Lens' S3Location (Maybe BundleType) Source

The file type of the application revision. Must be one of the following:

  • tar: A tar archive file.
  • tgz: A compressed tar archive file.
  • zip: A zip archive file.

slETag :: Lens' S3Location (Maybe Text) Source

The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.

slBucket :: Lens' S3Location (Maybe Text) Source

The name of the Amazon S3 bucket where the application revision is stored.

slKey :: Lens' S3Location (Maybe Text) Source

The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

slVersion :: Lens' S3Location (Maybe Text) Source

A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the version is not specified, the system will use the most recent version by default.

Tag

data Tag Source

Information about a tag.

See: tag smart constructor.

Instances

tag :: Tag Source

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tagValue :: Lens' Tag (Maybe Text) Source

The tag's value.

tagKey :: Lens' Tag (Maybe Text) Source

The tag's key.

TagFilter

data TagFilter Source

Information about an on-premises instance tag filter.

See: tagFilter smart constructor.

Instances

tagFilter :: TagFilter Source

Creates a value of TagFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tfValue :: Lens' TagFilter (Maybe Text) Source

The on-premises instance tag filter value.

tfKey :: Lens' TagFilter (Maybe Text) Source

The on-premises instance tag filter key.

tfType :: Lens' TagFilter (Maybe TagFilterType) Source

The on-premises instance tag filter type:

  • KEY_ONLY: Key only.
  • VALUE_ONLY: Value only.
  • KEY_AND_VALUE: Key and value.

TimeRange

data TimeRange Source

Information about a time range.

See: timeRange smart constructor.

Instances

timeRange :: TimeRange Source

Creates a value of TimeRange with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

trStart :: Lens' TimeRange (Maybe UTCTime) Source

The time range's start time.

Specify null to leave the time range's start time open-ended.

trEnd :: Lens' TimeRange (Maybe UTCTime) Source

The time range's end time.

Specify null to leave the time range's end time open-ended.