ExAws.CodeDeploy.Core

AWS CodeDeploy

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:

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

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

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

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

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

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

Source

Summary

add_tags_to_on_premises_instances!(client, input)

Same as add_tags_to_on_premises_instances/2 but raise on error

add_tags_to_on_premises_instances(client, input)

AddTagsToOnPremisesInstances

batch_get_applications!(client, input)

Same as batch_get_applications/2 but raise on error

batch_get_applications(client, input)

BatchGetApplications

batch_get_deployments!(client, input)

Same as batch_get_deployments/2 but raise on error

batch_get_deployments(client, input)

BatchGetDeployments

batch_get_on_premises_instances!(client, input)

Same as batch_get_on_premises_instances/2 but raise on error

batch_get_on_premises_instances(client, input)

BatchGetOnPremisesInstances

create_application!(client, input)

Same as create_application/2 but raise on error

create_application(client, input)

CreateApplication

create_deployment!(client, input)

Same as create_deployment/2 but raise on error

create_deployment(client, input)

CreateDeployment

create_deployment_config!(client, input)

Same as create_deployment_config/2 but raise on error

create_deployment_config(client, input)

CreateDeploymentConfig

create_deployment_group!(client, input)

Same as create_deployment_group/2 but raise on error

create_deployment_group(client, input)

CreateDeploymentGroup

delete_application!(client, input)

Same as delete_application/2 but raise on error

delete_application(client, input)

DeleteApplication

delete_deployment_config!(client, input)

Same as delete_deployment_config/2 but raise on error

delete_deployment_config(client, input)

DeleteDeploymentConfig

delete_deployment_group!(client, input)

Same as delete_deployment_group/2 but raise on error

delete_deployment_group(client, input)

DeleteDeploymentGroup

deregister_on_premises_instance!(client, input)

Same as deregister_on_premises_instance/2 but raise on error

deregister_on_premises_instance(client, input)

DeregisterOnPremisesInstance

get_application!(client, input)

Same as get_application/2 but raise on error

get_application(client, input)

GetApplication

get_application_revision!(client, input)

Same as get_application_revision/2 but raise on error

get_application_revision(client, input)

GetApplicationRevision

get_deployment!(client, input)

Same as get_deployment/2 but raise on error

get_deployment(client, input)

GetDeployment

get_deployment_config!(client, input)

Same as get_deployment_config/2 but raise on error

get_deployment_config(client, input)

GetDeploymentConfig

get_deployment_group!(client, input)

Same as get_deployment_group/2 but raise on error

get_deployment_group(client, input)

GetDeploymentGroup

get_deployment_instance!(client, input)

Same as get_deployment_instance/2 but raise on error

get_deployment_instance(client, input)

GetDeploymentInstance

get_on_premises_instance!(client, input)

Same as get_on_premises_instance/2 but raise on error

get_on_premises_instance(client, input)

GetOnPremisesInstance

list_application_revisions!(client, input)

Same as list_application_revisions/2 but raise on error

list_application_revisions(client, input)

ListApplicationRevisions

list_applications!(client, input)

Same as list_applications/2 but raise on error

list_applications(client, input)

ListApplications

list_deployment_configs!(client, input)

Same as list_deployment_configs/2 but raise on error

list_deployment_configs(client, input)

ListDeploymentConfigs

list_deployment_groups!(client, input)

Same as list_deployment_groups/2 but raise on error

list_deployment_groups(client, input)

ListDeploymentGroups

list_deployment_instances!(client, input)

Same as list_deployment_instances/2 but raise on error

list_deployment_instances(client, input)

ListDeploymentInstances

list_deployments!(client, input)

Same as list_deployments/2 but raise on error

list_deployments(client, input)

ListDeployments

list_on_premises_instances!(client, input)

Same as list_on_premises_instances/2 but raise on error

list_on_premises_instances(client, input)

ListOnPremisesInstances

register_application_revision!(client, input)

Same as register_application_revision/2 but raise on error

register_application_revision(client, input)

RegisterApplicationRevision

register_on_premises_instance!(client, input)

Same as register_on_premises_instance/2 but raise on error

register_on_premises_instance(client, input)

RegisterOnPremisesInstance

remove_tags_from_on_premises_instances!(client, input)

Same as remove_tags_from_on_premises_instances/2 but raise on error

remove_tags_from_on_premises_instances(client, input)

RemoveTagsFromOnPremisesInstances

stop_deployment!(client, input)

Same as stop_deployment/2 but raise on error

stop_deployment(client, input)

StopDeployment

update_application!(client, input)

Same as update_application/2 but raise on error

update_application(client, input)

UpdateApplication

update_deployment_group!(client, input)

Same as update_deployment_group/2 but raise on error

update_deployment_group(client, input)

UpdateDeploymentGroup

Types

list_applications_output :: [applications: applications_list, next_token: next_token]

list_deployment_instances_input :: [deployment_id: deployment_id, instance_status_filter: instance_status_list, next_token: next_token]

stop_deployment_input :: [{:deployment_id, deployment_id}]

diagnostics :: [error_code: lifecycle_error_code, log_tail: log_tail, message: lifecycle_message, script_name: script_name]

log_tail :: binary

error_message :: binary

role :: binary

instance_status :: binary

s3_location :: [bucket: s3_bucket, bundle_type: bundle_type, e_tag: e_tag, key: s3_key, version: version_id]

deployment_id :: binary

deployment_group_info :: [application_name: application_name, auto_scaling_groups: auto_scaling_group_list, deployment_config_name: deployment_config_name, deployment_group_id: deployment_group_id, deployment_group_name: deployment_group_name, ec2_tag_filters: ec2_tag_filter_list, on_premises_instance_tag_filters: tag_filter_list, service_role_arn: role, target_revision: revision_location]

list_deployment_groups_input :: [application_name: application_name, next_token: next_token]

list_deployment_groups_output :: [application_name: application_name, deployment_groups: deployment_groups_list, next_token: next_token]

time_range :: [end: timestamp, start: timestamp]

create_deployment_config_input :: [deployment_config_name: deployment_config_name, minimum_healthy_hosts: minimum_healthy_hosts]

git_hub_location :: [commit_id: commit_id, repository: repository]

list_deployment_configs_output :: [deployment_configs_list: deployment_configs_list, next_token: next_token]

get_deployment_group_input :: [application_name: application_name, deployment_group_name: deployment_group_name]

sort_order :: binary

tag_filter_type :: binary

lifecycle_event :: [diagnostics: diagnostics, end_time: timestamp, lifecycle_event_name: lifecycle_event_name, start_time: timestamp, status: lifecycle_event_status]

get_deployment_input :: [{:deployment_id, deployment_id}]

instance_summary :: [deployment_id: deployment_id, instance_id: instance_id, last_updated_at: timestamp, lifecycle_events: lifecycle_event_list, status: instance_status]

create_deployment_group_input :: [application_name: application_name, auto_scaling_groups: auto_scaling_group_name_list, deployment_config_name: deployment_config_name, deployment_group_name: deployment_group_name, ec2_tag_filters: ec2_tag_filter_list, on_premises_instance_tag_filters: tag_filter_list, service_role_arn: role]

key :: binary

instance_id :: binary

deployment_overview :: [failed: instance_count, in_progress: instance_count, pending: instance_count, skipped: instance_count, succeeded: instance_count]

delete_application_input :: [{:application_name, application_name}]

get_deployment_config_output :: [{:deployment_config_info, deployment_config_info}]

register_application_revision_input :: [application_name: application_name, description: description, revision: revision_location]

iam_user_arn :: binary

s3_bucket :: binary

get_deployment_config_input :: [{:deployment_config_name, deployment_config_name}]

description :: binary

error_code :: binary

create_deployment_output :: [{:deployment_id, deployment_id}]

create_deployment_input :: [application_name: application_name, deployment_config_name: deployment_config_name, deployment_group_name: deployment_group_name, description: description, ignore_application_stop_failures: boolean, revision: revision_location]

deployment_status :: binary

message :: binary

revision_location :: [git_hub_location: git_hub_location, revision_type: revision_location_type, s3_location: s3_location]

ec2_tag_filter :: [key: key, type: ec2_tag_filter_type, value: value]

list_deployments_output :: [deployments: deployments_list, next_token: next_token]

bundle_type :: binary

tag :: [key: key, value: value]

stop_status :: binary

update_application_input :: [application_name: application_name, new_application_name: application_name]

timestamp :: integer

delete_deployment_config_input :: [{:deployment_config_name, deployment_config_name}]

lifecycle_message :: binary

create_application_input :: [{:application_name, application_name}]

tag_filter :: [key: key, type: tag_filter_type, value: value]

create_application_output :: [{:application_id, application_id}]

tag_list :: [tag]

deployment_config_info :: [create_time: timestamp, deployment_config_id: deployment_config_id, deployment_config_name: deployment_config_name, minimum_healthy_hosts: minimum_healthy_hosts]

get_deployment_output :: [{:deployment_info, deployment_info}]

list_deployments_input :: [application_name: application_name, create_time_range: time_range, deployment_group_name: deployment_group_name, include_only_statuses: deployment_status_list, next_token: next_token]

stop_deployment_output :: [status: stop_status, status_message: message]

instance_count :: integer

get_deployment_instance_input :: [deployment_id: deployment_id, instance_id: instance_id]

version_id :: binary

repository :: binary

list_applications_input :: [{:next_token, next_token}]

value :: binary

deployment_creator :: binary

get_deployment_group_output :: [{:deployment_group_info, deployment_group_info}]

application_info :: [application_id: application_id, application_name: application_name, create_time: timestamp, linked_to_git_hub: boolean]

list_deployment_instances_output :: [instances_list: instances_list, next_token: next_token]

instance_name :: binary

instance_info :: [deregister_time: timestamp, iam_user_arn: iam_user_arn, instance_arn: instance_arn, instance_name: instance_name, register_time: timestamp, tags: tag_list]

delete_deployment_group_input :: [application_name: application_name, deployment_group_name: deployment_group_name]

instance_arn :: binary

application_name :: binary

commit_id :: binary

generic_revision_info :: [deployment_groups: deployment_groups_list, description: description, first_used_time: timestamp, last_used_time: timestamp, register_time: timestamp]

list_on_premises_instances_input :: [next_token: next_token, registration_status: registration_status, tag_filters: tag_filter_list]

script_name :: binary

application_id :: binary

e_tag :: binary

list_application_revisions_input :: [application_name: application_name, deployed: list_state_filter_action, next_token: next_token, s3_bucket: s3_bucket, s3_key_prefix: s3_key, sort_by: application_revision_sort_by, sort_order: sort_order]

update_deployment_group_input :: [application_name: application_name, auto_scaling_groups: auto_scaling_group_name_list, current_deployment_group_name: deployment_group_name, deployment_config_name: deployment_config_name, ec2_tag_filters: ec2_tag_filter_list, new_deployment_group_name: deployment_group_name, on_premises_instance_tag_filters: tag_filter_list, service_role_arn: role]

get_application_input :: [{:application_name, application_name}]

next_token :: binary

s3_key :: binary

batch_get_applications_input :: [{:application_names, applications_list}]

deployment_info :: [application_name: application_name, complete_time: timestamp, create_time: timestamp, creator: deployment_creator, deployment_config_name: deployment_config_name, deployment_group_name: deployment_group_name, deployment_id: deployment_id, deployment_overview: deployment_overview, description: description, error_information: error_information, ignore_application_stop_failures: boolean, revision: revision_location, start_time: timestamp, status: deployment_status]

Functions

add_tags_to_on_premises_instances(client, input)

Specs:

AddTagsToOnPremisesInstances

Adds tags to on-premises instances.

Source
add_tags_to_on_premises_instances!(client, input)

Specs:

Same as add_tags_to_on_premises_instances/2 but raise on error.

Source
batch_get_applications(client, input)

Specs:

BatchGetApplications

Gets information about one or more applications.

Source
batch_get_applications!(client, input)

Specs:

Same as batch_get_applications/2 but raise on error.

Source
batch_get_deployments(client, input)

Specs:

BatchGetDeployments

Gets information about one or more deployments.

Source
batch_get_deployments!(client, input)

Specs:

  • batch_get_deployments!(client :: ExAws.CodeDeploy.t, input :: batch_get_deployments_input) :: ExAws.Request.JSON.success_t | no_return

Same as batch_get_deployments/2 but raise on error.

Source
batch_get_on_premises_instances(client, input)

Specs:

BatchGetOnPremisesInstances

Gets information about one or more on-premises instances.

Source
batch_get_on_premises_instances!(client, input)

Specs:

Same as batch_get_on_premises_instances/2 but raise on error.

Source
create_application(client, input)

Specs:

CreateApplication

Creates a new application.

Source
create_application!(client, input)

Specs:

  • create_application!(client :: ExAws.CodeDeploy.t, input :: create_application_input) :: ExAws.Request.JSON.success_t | no_return

Same as create_application/2 but raise on error.

Source
create_deployment(client, input)

Specs:

  • create_deployment(client :: ExAws.CodeDeploy.t, input :: create_deployment_input) :: ExAws.Request.JSON.response_t

CreateDeployment

Deploys an application revision through the specified deployment group.

Source
create_deployment!(client, input)

Specs:

  • create_deployment!(client :: ExAws.CodeDeploy.t, input :: create_deployment_input) :: ExAws.Request.JSON.success_t | no_return

Same as create_deployment/2 but raise on error.

Source
create_deployment_config(client, input)

Specs:

CreateDeploymentConfig

Creates a new deployment configuration.

Source
create_deployment_config!(client, input)

Specs:

Same as create_deployment_config/2 but raise on error.

Source
create_deployment_group(client, input)

Specs:

CreateDeploymentGroup

Creates a new deployment group for application revisions to be deployed to.

Source
create_deployment_group!(client, input)

Specs:

Same as create_deployment_group/2 but raise on error.

Source
delete_application(client, input)

Specs:

DeleteApplication

Deletes an application.

Source
delete_application!(client, input)

Specs:

  • delete_application!(client :: ExAws.CodeDeploy.t, input :: delete_application_input) :: ExAws.Request.JSON.success_t | no_return

Same as delete_application/2 but raise on error.

Source
delete_deployment_config(client, input)

Specs:

DeleteDeploymentConfig

Deletes a deployment configuration.

Note:A deployment configuration cannot be deleted if it is currently in use. Also, predefined configurations cannot be deleted.

Source
delete_deployment_config!(client, input)

Specs:

Same as delete_deployment_config/2 but raise on error.

Source
delete_deployment_group(client, input)

Specs:

DeleteDeploymentGroup

Deletes a deployment group.

Source
delete_deployment_group!(client, input)

Specs:

Same as delete_deployment_group/2 but raise on error.

Source
deregister_on_premises_instance(client, input)

Specs:

DeregisterOnPremisesInstance

Deregisters an on-premises instance.

Source
deregister_on_premises_instance!(client, input)

Specs:

Same as deregister_on_premises_instance/2 but raise on error.

Source
get_application(client, input)

Specs:

  • get_application(client :: ExAws.CodeDeploy.t, input :: get_application_input) :: ExAws.Request.JSON.response_t

GetApplication

Gets information about an application.

Source
get_application!(client, input)

Specs:

  • get_application!(client :: ExAws.CodeDeploy.t, input :: get_application_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_application/2 but raise on error.

Source
get_application_revision(client, input)

Specs:

GetApplicationRevision

Gets information about an application revision.

Source
get_application_revision!(client, input)

Specs:

Same as get_application_revision/2 but raise on error.

Source
get_deployment(client, input)

Specs:

  • get_deployment(client :: ExAws.CodeDeploy.t, input :: get_deployment_input) :: ExAws.Request.JSON.response_t

GetDeployment

Gets information about a deployment.

Source
get_deployment!(client, input)

Specs:

  • get_deployment!(client :: ExAws.CodeDeploy.t, input :: get_deployment_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_deployment/2 but raise on error.

Source
get_deployment_config(client, input)

Specs:

GetDeploymentConfig

Gets information about a deployment configuration.

Source
get_deployment_config!(client, input)

Specs:

  • get_deployment_config!(client :: ExAws.CodeDeploy.t, input :: get_deployment_config_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_deployment_config/2 but raise on error.

Source
get_deployment_group(client, input)

Specs:

GetDeploymentGroup

Gets information about a deployment group.

Source
get_deployment_group!(client, input)

Specs:

  • get_deployment_group!(client :: ExAws.CodeDeploy.t, input :: get_deployment_group_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_deployment_group/2 but raise on error.

Source
get_deployment_instance(client, input)

Specs:

GetDeploymentInstance

Gets information about an instance as part of a deployment.

Source
get_deployment_instance!(client, input)

Specs:

Same as get_deployment_instance/2 but raise on error.

Source
get_on_premises_instance(client, input)

Specs:

GetOnPremisesInstance

Gets information about an on-premises instance.

Source
get_on_premises_instance!(client, input)

Specs:

Same as get_on_premises_instance/2 but raise on error.

Source
list_application_revisions(client, input)

Specs:

ListApplicationRevisions

Lists information about revisions for an application.

Source
list_application_revisions!(client, input)

Specs:

Same as list_application_revisions/2 but raise on error.

Source
list_applications(client, input)

Specs:

  • list_applications(client :: ExAws.CodeDeploy.t, input :: list_applications_input) :: ExAws.Request.JSON.response_t

ListApplications

Lists the applications registered with the applicable IAM user or AWS account.

Source
list_applications!(client, input)

Specs:

  • list_applications!(client :: ExAws.CodeDeploy.t, input :: list_applications_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_applications/2 but raise on error.

Source
list_deployment_configs(client, input)

Specs:

ListDeploymentConfigs

Lists the deployment configurations with the applicable IAM user or AWS account.

Source
list_deployment_configs!(client, input)

Specs:

Same as list_deployment_configs/2 but raise on error.

Source
list_deployment_groups(client, input)

Specs:

ListDeploymentGroups

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

Source
list_deployment_groups!(client, input)

Specs:

Same as list_deployment_groups/2 but raise on error.

Source
list_deployment_instances(client, input)

Specs:

ListDeploymentInstances

Lists the instances for a deployment associated with the applicable IAM user or AWS account.

Source
list_deployment_instances!(client, input)

Specs:

Same as list_deployment_instances/2 but raise on error.

Source
list_deployments(client, input)

Specs:

  • list_deployments(client :: ExAws.CodeDeploy.t, input :: list_deployments_input) :: ExAws.Request.JSON.response_t

ListDeployments

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

Source
list_deployments!(client, input)

Specs:

  • list_deployments!(client :: ExAws.CodeDeploy.t, input :: list_deployments_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_deployments/2 but raise on error.

Source
list_on_premises_instances(client, input)

Specs:

ListOnPremisesInstances

Gets a list of one or more on-premises instance names.

Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

Source
list_on_premises_instances!(client, input)

Specs:

Same as list_on_premises_instances/2 but raise on error.

Source
register_application_revision(client, input)

Specs:

RegisterApplicationRevision

Registers with AWS CodeDeploy a revision for the specified application.

Source
register_application_revision!(client, input)

Specs:

Same as register_application_revision/2 but raise on error.

Source
register_on_premises_instance(client, input)

Specs:

RegisterOnPremisesInstance

Registers an on-premises instance.

Source
register_on_premises_instance!(client, input)

Specs:

Same as register_on_premises_instance/2 but raise on error.

Source
remove_tags_from_on_premises_instances(client, input)

Specs:

RemoveTagsFromOnPremisesInstances

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

Source
remove_tags_from_on_premises_instances!(client, input)

Specs:

Same as remove_tags_from_on_premises_instances/2 but raise on error.

Source
stop_deployment(client, input)

Specs:

  • stop_deployment(client :: ExAws.CodeDeploy.t, input :: stop_deployment_input) :: ExAws.Request.JSON.response_t

StopDeployment

Attempts to stop an ongoing deployment.

Source
stop_deployment!(client, input)

Specs:

  • stop_deployment!(client :: ExAws.CodeDeploy.t, input :: stop_deployment_input) :: ExAws.Request.JSON.success_t | no_return

Same as stop_deployment/2 but raise on error.

Source
update_application(client, input)

Specs:

UpdateApplication

Changes an existing application’s name.

Source
update_application!(client, input)

Specs:

  • update_application!(client :: ExAws.CodeDeploy.t, input :: update_application_input) :: ExAws.Request.JSON.success_t | no_return

Same as update_application/2 but raise on error.

Source
update_deployment_group(client, input)

Specs:

UpdateDeploymentGroup

Changes information about an existing deployment group.

Source
update_deployment_group!(client, input)

Specs:

Same as update_deployment_group/2 but raise on error.

Source