amazonka-codedeploy-1.4.0: Amazon CodeDeploy SDK.

Copyright(c) 2013-2016 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.Types

Contents

Description

 

Synopsis

Service Configuration

codeDeploy :: Service Source

API version '2014-10-06' of the Amazon CodeDeploy SDK configuration.

Errors

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

The limit for lifecycle hooks was exceeded.

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

The specified time range was specified in an invalid format.

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

The specified tag was specified in an invalid format.

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

The specified on-premises instance name is already registered.

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

An IAM user ARN was not specified.

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

The deployment group name was specified in an invalid format.

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

The description is too long.

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

The IAM user ARN was specified in an invalid format.

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

The specified deployment has not started.

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

The deployment configurations limit was exceeded.

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

The role ID was not specified.

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

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

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

The number of allowed deployments was exceeded.

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

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

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

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

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

The deployed state filter was specified in an invalid format.

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

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

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

The application name was specified in an invalid format.

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

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

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

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

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

The specified tag filter was specified in an invalid format.

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

The trigger was specified in an invalid format.

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

A tag was not specified.

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

The deployment group name was not specified.

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

A bucket name is required, but was not provided.

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

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

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

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

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

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

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

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

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

The deployment groups limit was exceeded.

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

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

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

The deployment configuration name was specified in an invalid format.

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

The deployment configuration name was not specified.

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

At least one deployment ID must be specified.

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

The next token was specified in an invalid format.

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

The instance ID was not specified.

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

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

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

The sort order was specified in an invalid format.

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

The deployment is already complete.

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

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

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

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

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

The revision was specified in an invalid format.

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

The revision ID was not specified.

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

The specified instance does not exist in the deployment group.

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

The deployment configuration is still in use.

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

The tag was specified in an invalid format.

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

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

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

An on-premises instance name was not specified.

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

The maximum allowed number of triggers was exceeded.

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

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

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

The registration status was specified in an invalid format.

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

The minimum number of required application names was not specified.

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

The specified on-premises instance is not registered.

_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 :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified instance status does not exist.

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

The maximum allowed number of tags was exceeded.

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

More applications were attempted to be created than are allowed.

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

An invalid operation was detected.

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

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

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

TriggerEventType

data TriggerEventType Source

Constructors

DeploymentFailure 
DeploymentStart 
DeploymentStop 
DeploymentSuccess 
InstanceFailure 
InstanceStart 
InstanceSuccess 

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 at which 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 instance.

dciDeploymentConfigId :: Lens' DeploymentConfigInfo (Maybe Text) Source

The deployment configuration ID.

dciCreateTime :: Lens' DeploymentConfigInfo (Maybe UTCTime) Source

The time at which 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 type and location.

dgiEc2TagFilters :: Lens' DeploymentGroupInfo [EC2TagFilter] Source

The Amazon EC2 tags on which to filter.

dgiOnPremisesInstanceTagFilters :: Lens' DeploymentGroupInfo [TagFilter] Source

The on-premises instance tags on which to filter.

dgiApplicationName :: Lens' DeploymentGroupInfo (Maybe Text) Source

The application name.

dgiTriggerConfigurations :: Lens' DeploymentGroupInfo [TriggerConfig] Source

A list of associated triggers.

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:

diCreator :: Lens' DeploymentInfo (Maybe DeploymentCreator) Source

The means by which 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.

diDeploymentId :: Lens' DeploymentInfo (Maybe Text) Source

The deployment ID.

diDeploymentConfigName :: Lens' DeploymentInfo (Maybe Text) Source

The deployment configuration name.

diStartTime :: Lens' DeploymentInfo (Maybe UTCTime) Source

A timestamp indicating when the deployment was deployed to the deployment group.

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 back-end servers that participate in the deployment process.

diCompleteTime :: Lens' DeploymentInfo (Maybe UTCTime) Source

A timestamp indicating when the deployment was complete.

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 stored application artifacts and the service from which to retrieve them.

diDescription :: Lens' DeploymentInfo (Maybe Text) Source

A comment about the deployment.

diCreateTime :: Lens' DeploymentInfo (Maybe UTCTime) Source

A timestamp indicating when the deployment was created.

diDeploymentGroupName :: Lens' DeploymentInfo (Maybe Text) Source

The deployment group name.

diIgnoreApplicationStopFailures :: Lens' DeploymentInfo (Maybe Bool) Source

If true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed 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 an instance to fail, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.

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 in the deployment in a pending state.

doSkipped :: Lens' DeploymentOverview (Maybe Integer) Source

The number of instances in the deployment in a skipped state.

doInProgress :: Lens' DeploymentOverview (Maybe Integer) Source

The number of instances in which the deployment is in progress.

doSucceeded :: Lens' DeploymentOverview (Maybe Integer) Source

The number of instances in the deployment to which revisions have been successfully deployed.

doFailed :: Lens' DeploymentOverview (Maybe Integer) Source

The number of instances in the deployment in a failed state.

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 diagnostic log.

If available, AWS CodeDeploy returns up to the last 4 KB of the 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. This error code will most likely be raised if the application is deleted after the deployment is created but before it is started.
  • DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code will most likely be raised if the deployment group is deleted after the deployment is created but before it is started.
  • HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.
  • HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints 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 instance were specified, or no instance can be found.
  • OVER_MAX_INSTANCES: The maximum number of instance 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. This error code will most likely be raised if the revision is deleted after the deployment is created but before it is started.

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

The deployment groups for which this is the current target 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 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 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:

iiRegisterTime :: Lens' InstanceInfo (Maybe UTCTime) Source

The time at which the on-premises instance was registered.

iiInstanceARN :: Lens' InstanceInfo (Maybe Text) Source

The ARN of the on-premises instance.

iiDeregisterTime :: Lens' InstanceInfo (Maybe UTCTime) Source

If the on-premises instance was deregistered, the time at which 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 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.

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.

isDeploymentId :: Lens' InstanceSummary (Maybe Text) Source

The deployment ID.

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 ran successfully.
  • Failed: The deployment lifecycle event has failed.
  • Skipped: The deployment lifecycle event has been skipped.
  • Unknown: The deployment lifecycle event is unknown.

leLifecycleEventName :: Lens' LifecycleEvent (Maybe Text) Source

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

leStartTime :: Lens' LifecycleEvent (Maybe UTCTime) Source

A timestamp indicating when the deployment lifecycle event started.

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

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 instance value.

mhhType :: Lens' MinimumHealthyHosts (Maybe MinimumHealthyHostsType) Source

The minimum healthy instance type:

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

In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment will be successful if six or more instances are deployed to successfully; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment will be successful if four or more instance are deployed to successfully; otherwise, the deployment fails.

In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy will try to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment still succeeds.

RevisionInfo

data RevisionInfo Source

Information about an application revision.

See: revisionInfo smart constructor.

Instances

revisionInfo :: RevisionInfo Source

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

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

riGenericRevisionInfo :: Lens' RevisionInfo (Maybe GenericRevisionInfo) Source

Undocumented member.

riRevisionLocation :: Lens' RevisionInfo (Maybe RevisionLocation) Source

Undocumented member.

RevisionLocation

data RevisionLocation Source

Information about the location of an application revision.

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 type of application revision:

  • 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 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 start time of the time range.

Specify null to leave the start time open-ended.

trEnd :: Lens' TimeRange (Maybe UTCTime) Source

The end time of the time range.

Specify null to leave the end time open-ended.

TriggerConfig

data TriggerConfig Source

Information about notification triggers for the deployment group.

See: triggerConfig smart constructor.

Instances

triggerConfig :: TriggerConfig Source

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

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

tcTriggerName :: Lens' TriggerConfig (Maybe Text) Source

The name of the notification trigger.

tcTriggerEvents :: Lens' TriggerConfig [TriggerEventType] Source

The event type or types for which notifications are triggered.

The following event type values are supported:

  • DEPLOYMENT_START
  • DEPLOYMENT_SUCCESS
  • DEPLOYMENT_FAILURE
  • DEPLOYMENT_STOP
  • INSTANCE_START
  • INSTANCE_SUCCESS
  • INSTANCE_FAILURE

tcTriggerTargetARN :: Lens' TriggerConfig (Maybe Text) Source

The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.