Codedeploy

This page documents function available when using the Codedeploy module, created with @service Codedeploy.

Index

Documentation

Main.Codedeploy.add_tags_to_on_premises_instancesMethod
add_tags_to_on_premises_instances(instance_names, tags)
add_tags_to_on_premises_instances(instance_names, tags, params::Dict{String,<:Any})

Adds tags to on-premises instances.

Arguments

  • instance_names: The names of the on-premises instances to which to add tags.
  • tags: The tag key-value pairs to add to the on-premises instances. Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.
Main.Codedeploy.batch_get_application_revisionsMethod
batch_get_application_revisions(application_name, revisions)
batch_get_application_revisions(application_name, revisions, params::Dict{String,<:Any})

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

Arguments

  • application_name: The name of an CodeDeploy application about which to get revision information.
  • revisions: An array of RevisionLocation objects that specify information to get about the application revisions, including type and location. The maximum number of RevisionLocation objects you can specify is 25.
Main.Codedeploy.batch_get_applicationsMethod
batch_get_applications(application_names)
batch_get_applications(application_names, params::Dict{String,<:Any})

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

Arguments

  • application_names: A list of application names separated by spaces. The maximum number of application names you can specify is 100.
Main.Codedeploy.batch_get_deployment_groupsMethod
batch_get_deployment_groups(application_name, deployment_group_names)
batch_get_deployment_groups(application_name, deployment_group_names, params::Dict{String,<:Any})

Gets information about one or more deployment groups.

Arguments

  • application_name: The name of an CodeDeploy application associated with the applicable IAM or Amazon Web Services account.
  • deployment_group_names: The names of the deployment groups.
Main.Codedeploy.batch_get_deployment_instancesMethod
batch_get_deployment_instances(deployment_id, instance_ids)
batch_get_deployment_instances(deployment_id, instance_ids, params::Dict{String,<:Any})

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.

Arguments

  • deployment_id: The unique ID of a deployment.
  • instance_ids: The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.
Main.Codedeploy.batch_get_deployment_targetsMethod
batch_get_deployment_targets()
batch_get_deployment_targets(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "deploymentId": The unique ID of a deployment.
  • "targetIds": The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25. For deployments that use the EC2/On-premises compute platform, the target IDs are Amazon EC2 or on-premises instances IDs, and their target type is instanceTarget. For deployments that use the Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget. For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format &lt;clustername&gt;:&lt;servicename&gt;. Their target type is ecsTarget. For deployments that are deployed with CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is cloudFormationTarget.
Main.Codedeploy.batch_get_deploymentsMethod
batch_get_deployments(deployment_ids)
batch_get_deployments(deployment_ids, params::Dict{String,<:Any})

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

Arguments

  • deployment_ids: A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.
Main.Codedeploy.batch_get_on_premises_instancesMethod
batch_get_on_premises_instances(instance_names)
batch_get_on_premises_instances(instance_names, params::Dict{String,<:Any})

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

Arguments

  • instance_names: The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.
Main.Codedeploy.continue_deploymentMethod
continue_deployment()
continue_deployment(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "deploymentId": The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.
  • "deploymentWaitType": The status of the deployment's waiting period. READYWAIT indicates that the deployment is ready to start shifting traffic. TERMINATIONWAIT indicates that the traffic is shifted, but the original target is not terminated.
Main.Codedeploy.create_applicationMethod
create_application(application_name)
create_application(application_name, params::Dict{String,<:Any})

Creates an application.

Arguments

  • application_name: The name of the application. This name must be unique with the applicable IAM or Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "computePlatform": The destination platform type for the deployment (Lambda, Server, or ECS).
  • "tags": The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
Main.Codedeploy.create_deploymentMethod
create_deployment(application_name)
create_deployment(application_name, params::Dict{String,<:Any})

Deploys an application revision through the specified deployment group.

Arguments

  • application_name: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "autoRollbackConfiguration": Configuration information for an automatic rollback that is added when a deployment is created.
  • "deploymentConfigName": The name of a deployment configuration associated with the IAM user or Amazon Web Services account. If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default.
  • "deploymentGroupName": The name of the deployment group.
  • "description": A comment about the deployment.
  • "fileExistsBehavior": Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment. The fileExistsBehavior parameter takes any of the following values: DISALLOW: The deployment fails. This is also the default behavior if no option is specified. OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance. RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
  • "ignoreApplicationStopFailures": If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop. If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted. During a deployment, the CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail. If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.
  • "overrideAlarmConfiguration": Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment. If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.
  • "revision": The type and location of the revision to deploy.
  • "targetInstances": Information about the instances that belong to the replacement environment in a blue/green deployment.
  • "updateOutdatedInstancesOnly": Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
Main.Codedeploy.create_deployment_configMethod
create_deployment_config(deployment_config_name)
create_deployment_config(deployment_config_name, params::Dict{String,<:Any})

Creates a deployment configuration.

Arguments

  • deployment_config_name: The name of the deployment configuration to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "computePlatform": The destination platform type for the deployment (Lambda, Server, or ECS).
  • "minimumHealthyHosts": The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value. The type parameter takes either of the following values: HOSTCOUNT: The value parameter represents the minimum number of healthy instances as an absolute value. FLEETPERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEETPERCENT, at the start of the deployment, CodeDeploy converts the percentage to the equivalent number of instances and rounds up fractional instances. The value parameter takes an integer. For example, to set a minimum of 95% healthy instance, specify a type of FLEETPERCENT and a value of 95.
  • "trafficRoutingConfig": The configuration that specifies how the deployment traffic is routed.
Main.Codedeploy.create_deployment_groupMethod
create_deployment_group(application_name, deployment_group_name, service_role_arn)
create_deployment_group(application_name, deployment_group_name, service_role_arn, params::Dict{String,<:Any})

Creates a deployment group to which application revisions are deployed.

Arguments

  • application_name: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
  • deployment_group_name: The name of a new deployment group for the specified application.
  • service_role_arn: A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alarmConfiguration": Information to add about Amazon CloudWatch alarms when the deployment group is created.
  • "autoRollbackConfiguration": Configuration information for an automatic rollback that is added when a deployment group is created.
  • "autoScalingGroups": A list of associated Amazon EC2 Auto Scaling groups.
  • "blueGreenDeploymentConfiguration": Information about blue/green deployment options for a deployment group.
  • "deploymentConfigName": If specified, the deployment configuration name can be either one of the predefined configurations provided with CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation. CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group. For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.
  • "deploymentStyle": Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.
  • "ec2TagFilters": The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.
  • "ec2TagSet": Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.
  • "ecsServices": The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format &lt;clustername&gt;:&lt;servicename&gt;.
  • "loadBalancerInfo": Information about the load balancer used in a deployment.
  • "onPremisesInstanceTagFilters": The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.
  • "onPremisesTagSet": Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.
  • "outdatedInstancesStrategy": Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision. If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances. If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.
  • "tags": The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
  • "triggerConfigurations": Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.
Main.Codedeploy.delete_applicationMethod
delete_application(application_name)
delete_application(application_name, params::Dict{String,<:Any})

Deletes an application.

Arguments

  • application_name: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
Main.Codedeploy.delete_deployment_configMethod
delete_deployment_config(deployment_config_name)
delete_deployment_config(deployment_config_name, params::Dict{String,<:Any})

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

Arguments

  • deployment_config_name: The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
Main.Codedeploy.delete_deployment_groupMethod
delete_deployment_group(application_name, deployment_group_name)
delete_deployment_group(application_name, deployment_group_name, params::Dict{String,<:Any})

Deletes a deployment group.

Arguments

  • application_name: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
  • deployment_group_name: The name of a deployment group for the specified application.
Main.Codedeploy.delete_git_hub_account_tokenMethod
delete_git_hub_account_token()
delete_git_hub_account_token(params::Dict{String,<:Any})

Deletes a GitHub account connection.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tokenName": The name of the GitHub account connection to delete.
Main.Codedeploy.delete_resources_by_external_idMethod
delete_resources_by_external_id()
delete_resources_by_external_id(params::Dict{String,<:Any})

Deletes resources linked to an external ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "externalId": The unique ID of an external resource (for example, a CloudFormation stack ID) that is linked to one or more CodeDeploy resources.
Main.Codedeploy.deregister_on_premises_instanceMethod
deregister_on_premises_instance(instance_name)
deregister_on_premises_instance(instance_name, params::Dict{String,<:Any})

Deregisters an on-premises instance.

Arguments

  • instance_name: The name of the on-premises instance to deregister.
Main.Codedeploy.get_applicationMethod
get_application(application_name)
get_application(application_name, params::Dict{String,<:Any})

Gets information about an application.

Arguments

  • application_name: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
Main.Codedeploy.get_application_revisionMethod
get_application_revision(application_name, revision)
get_application_revision(application_name, revision, params::Dict{String,<:Any})

Gets information about an application revision.

Arguments

  • application_name: The name of the application that corresponds to the revision.
  • revision: Information about the application revision to get, including type and location.
Main.Codedeploy.get_deploymentMethod
get_deployment(deployment_id)
get_deployment(deployment_id, params::Dict{String,<:Any})

Gets information about a deployment. The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and the sha256 property of the returned appSpecContent object to get the content of the deployment’s AppSpec file.

Arguments

  • deployment_id: The unique ID of a deployment associated with the IAM user or Amazon Web Services account.
Main.Codedeploy.get_deployment_configMethod
get_deployment_config(deployment_config_name)
get_deployment_config(deployment_config_name, params::Dict{String,<:Any})

Gets information about a deployment configuration.

Arguments

  • deployment_config_name: The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
Main.Codedeploy.get_deployment_groupMethod
get_deployment_group(application_name, deployment_group_name)
get_deployment_group(application_name, deployment_group_name, params::Dict{String,<:Any})

Gets information about a deployment group.

Arguments

  • application_name: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
  • deployment_group_name: The name of a deployment group for the specified application.
Main.Codedeploy.get_deployment_instanceMethod
get_deployment_instance(deployment_id, instance_id)
get_deployment_instance(deployment_id, instance_id, params::Dict{String,<:Any})

Gets information about an instance as part of a deployment.

Arguments

  • deployment_id: The unique ID of a deployment.
  • instance_id: The unique ID of an instance in the deployment group.
Main.Codedeploy.get_deployment_targetMethod
get_deployment_target()
get_deployment_target(params::Dict{String,<:Any})

Returns information about a deployment target.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "deploymentId": The unique ID of a deployment.
  • "targetId": The unique ID of a deployment target.
Main.Codedeploy.get_on_premises_instanceMethod
get_on_premises_instance(instance_name)
get_on_premises_instance(instance_name, params::Dict{String,<:Any})

Gets information about an on-premises instance.

Arguments

  • instance_name: The name of the on-premises instance about which to get information.
Main.Codedeploy.list_application_revisionsMethod
list_application_revisions(application_name)
list_application_revisions(application_name, params::Dict{String,<:Any})

Lists information about revisions for an application.

Arguments

  • application_name: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "deployed": Whether to list revisions based on whether the revision is the target revision of a deployment group: include: List revisions that are target revisions of a deployment group. exclude: Do not list revisions that are target revisions of a deployment group. ignore: List all revisions.
  • "nextToken": An identifier returned from the previous ListApplicationRevisions call. It can be used to return the next set of applications in the list.
  • "s3Bucket": An Amazon S3 bucket name to limit the search for revisions. If set to null, all of the user's buckets are searched.
  • "s3KeyPrefix": A key prefix for the set of Amazon S3 objects to limit the search for revisions.
  • "sortBy": The column name to use to sort the list results: registerTime: Sort by the time the revisions were registered with CodeDeploy. firstUsedTime: Sort by the time the revisions were first used in a deployment. lastUsedTime: Sort by the time the revisions were last used in a deployment. If not specified or set to null, the results are returned in an arbitrary order.
  • "sortOrder": The order in which to sort the list results: ascending: ascending order. descending: descending order. If not specified, the results are sorted in ascending order. If set to null, the results are sorted in an arbitrary order.
Main.Codedeploy.list_applicationsMethod
list_applications()
list_applications(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.
Main.Codedeploy.list_deployment_configsMethod
list_deployment_configs()
list_deployment_configs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": An identifier returned from the previous ListDeploymentConfigs call. It can be used to return the next set of deployment configurations in the list.
Main.Codedeploy.list_deployment_groupsMethod
list_deployment_groups(application_name)
list_deployment_groups(application_name, params::Dict{String,<:Any})

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

Arguments

  • application_name: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.
Main.Codedeploy.list_deployment_instancesMethod
list_deployment_instances(deployment_id)
list_deployment_instances(deployment_id, params::Dict{String,<:Any})

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 IAM user or Amazon Web Services account.

Arguments

  • deployment_id: The unique ID of a deployment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "instanceStatusFilter": A subset of instances to list by status: Pending: Include those instances with pending deployments. InProgress: Include those instances where deployments are still in progress. Succeeded: Include those instances with successful deployments. Failed: Include those instances with failed deployments. Skipped: Include those instances with skipped deployments. Unknown: Include those instances with deployments in an unknown state.
  • "instanceTypeFilter": The set of instances in a blue/green deployment, either those in the original environment ("BLUE") or those in the replacement environment ("GREEN"), for which you want to view instance information.
  • "nextToken": An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list.
Main.Codedeploy.list_deployment_targetsMethod
list_deployment_targets()
list_deployment_targets(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "deploymentId": The unique ID of a deployment.
  • "nextToken": A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list.
  • "targetFilters": A key used to filter the returned targets. The two valid values are: TargetStatus - A TargetStatus filter string can be Failed, InProgress, Pending, Ready, Skipped, Succeeded, or Unknown. ServerInstanceLabel - A ServerInstanceLabel filter string can be Blue or Green.
Main.Codedeploy.list_deploymentsMethod
list_deployments()
list_deployments(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "applicationName": The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account. If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.
  • "createTimeRange": A time range (start and end) for returning a subset of the list of deployments.
  • "deploymentGroupName": The name of a deployment group for the specified application. If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.
  • "externalId": The unique ID of an external resource for returning deployments linked to the external resource.
  • "includeOnlyStatuses": A subset of deployments to list by status: Created: Include created deployments in the resulting list. Queued: Include queued deployments in the resulting list. In Progress: Include in-progress deployments in the resulting list. Succeeded: Include successful deployments in the resulting list. Failed: Include failed deployments in the resulting list. Stopped: Include stopped deployments in the resulting list.
  • "nextToken": An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
Main.Codedeploy.list_git_hub_account_token_namesMethod
list_git_hub_account_token_names()
list_git_hub_account_token_names(params::Dict{String,<:Any})

Lists the names of stored connections to GitHub accounts.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list.
Main.Codedeploy.list_on_premises_instancesMethod
list_on_premises_instances()
list_on_premises_instances(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.
  • "registrationStatus": The registration status of the on-premises instances: Deregistered: Include deregistered on-premises instances in the resulting list. Registered: Include registered on-premises instances in the resulting list.
  • "tagFilters": The on-premises instance tags that are used to restrict the on-premises instance names returned.
Main.Codedeploy.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags associated with the resource that is identified by the ResourceArn.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": An identifier returned from the previous ListTagsForResource call. It can be used to return the next set of applications in the list.
Main.Codedeploy.put_lifecycle_event_hook_execution_statusMethod
put_lifecycle_event_hook_execution_status()
put_lifecycle_event_hook_execution_status(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "deploymentId": The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.
  • "lifecycleEventHookExecutionId": The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file.
  • "status": The result of a Lambda function that validates a deployment lifecycle event. The values listed in Valid Values are valid for lifecycle statuses in general; however, only Succeeded and Failed can be passed successfully in your API call.
Main.Codedeploy.register_application_revisionMethod
register_application_revision(application_name, revision)
register_application_revision(application_name, revision, params::Dict{String,<:Any})

Registers with CodeDeploy a revision for the specified application.

Arguments

  • application_name: The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
  • revision: Information about the application revision to register, including type and location.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A comment about the revision.
Main.Codedeploy.register_on_premises_instanceMethod
register_on_premises_instance(instance_name)
register_on_premises_instance(instance_name, params::Dict{String,<:Any})

Registers an on-premises instance. Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.

Arguments

  • instance_name: The name of the on-premises instance to register.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "iamSessionArn": The ARN of the IAM session to associate with the on-premises instance.
  • "iamUserArn": The ARN of the IAM user to associate with the on-premises instance.
Main.Codedeploy.remove_tags_from_on_premises_instancesMethod
remove_tags_from_on_premises_instances(instance_names, tags)
remove_tags_from_on_premises_instances(instance_names, tags, params::Dict{String,<:Any})

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

Arguments

  • instance_names: The names of the on-premises instances from which to remove tags.
  • tags: The tag key-value pairs to remove from the on-premises instances.
Main.Codedeploy.skip_wait_time_for_instance_terminationMethod
skip_wait_time_for_instance_termination()
skip_wait_time_for_instance_termination(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "deploymentId": The unique ID of a blue/green deployment for which you want to skip the instance termination wait time.
Main.Codedeploy.stop_deploymentMethod
stop_deployment(deployment_id)
stop_deployment(deployment_id, params::Dict{String,<:Any})

Attempts to stop an ongoing deployment.

Arguments

  • deployment_id: The unique ID of a deployment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "autoRollbackEnabled": Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.
Main.Codedeploy.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The ARN of a resource, such as a CodeDeploy application or deployment group.
  • tags: A list of tags that TagResource associates with a resource. The resource is identified by the ResourceArn input parameter.
Main.Codedeploy.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) that specifies from which resource to disassociate the tags with the keys in the TagKeys input parameter.
  • tag_keys: A list of keys of Tag objects. The Tag objects identified by the keys are disassociated from the resource specified by the ResourceArn input parameter.
Main.Codedeploy.update_applicationMethod
update_application()
update_application(params::Dict{String,<:Any})

Changes the name of an application.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "applicationName": The current name of the application you want to change.
  • "newApplicationName": The new name to give the application.
Main.Codedeploy.update_deployment_groupMethod
update_deployment_group(application_name, current_deployment_group_name)
update_deployment_group(application_name, current_deployment_group_name, params::Dict{String,<:Any})

Changes information about a deployment group.

Arguments

  • application_name: The application name that corresponds to the deployment group to update.
  • current_deployment_group_name: The current name of the deployment group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alarmConfiguration": Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
  • "autoRollbackConfiguration": Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
  • "autoScalingGroups": The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the Auto Scaling groups, enter their names or do not specify this parameter. To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout" in the CodeDeploy User Guide.
  • "blueGreenDeploymentConfiguration": Information about blue/green deployment options for a deployment group.
  • "deploymentConfigName": The replacement deployment configuration name to use, if you want to change it.
  • "deploymentStyle": Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
  • "ec2TagFilters": The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
  • "ec2TagSet": Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.
  • "ecsServices": The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format &lt;clustername&gt;:&lt;servicename&gt;.
  • "loadBalancerInfo": Information about the load balancer used in a deployment.
  • "newDeploymentGroupName": The new name of the deployment group, if you want to change it.
  • "onPremisesInstanceTagFilters": The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
  • "onPremisesTagSet": Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.
  • "outdatedInstancesStrategy": Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision. If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances. If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.
  • "serviceRoleArn": A replacement ARN for the service role, if you want to change it.
  • "triggerConfigurations": Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.