ExAws.OpsWorks.Core

AWS OpsWorks

AWS OpsWorks

Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes.

AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.

SDKs and CLI

The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

Endpoints

AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region.

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended value for Linux stacks, which is also the default value, is currently 11.10. Windows stacks use Chef 12.2. For more information, see Chef Versions.

Note:You can also specify Chef 11.4 or Chef 0.9 for your Linux stack. However, Chef 0.9 has been deprecated. We do not recommend using Chef 0.9 for new stacks, and we recommend migrating your existing Chef 0.9 stacks to Chef 11.10 as soon as possible.

Source

Summary

assign_instance!(client, input)

Same as assign_instance/2 but raise on error

assign_instance(client, input)

AssignInstance

assign_volume!(client, input)

Same as assign_volume/2 but raise on error

assign_volume(client, input)

AssignVolume

associate_elastic_ip!(client, input)

Same as associate_elastic_ip/2 but raise on error

associate_elastic_ip(client, input)

AssociateElasticIp

attach_elastic_load_balancer!(client, input)

Same as attach_elastic_load_balancer/2 but raise on error

attach_elastic_load_balancer(client, input)

AttachElasticLoadBalancer

clone_stack!(client, input)

Same as clone_stack/2 but raise on error

clone_stack(client, input)

CloneStack

create_app!(client, input)

Same as create_app/2 but raise on error

create_app(client, input)

CreateApp

create_deployment!(client, input)

Same as create_deployment/2 but raise on error

create_deployment(client, input)

CreateDeployment

create_instance!(client, input)

Same as create_instance/2 but raise on error

create_instance(client, input)

CreateInstance

create_layer!(client, input)

Same as create_layer/2 but raise on error

create_layer(client, input)

CreateLayer

create_stack!(client, input)

Same as create_stack/2 but raise on error

create_stack(client, input)

CreateStack

create_user_profile!(client, input)

Same as create_user_profile/2 but raise on error

create_user_profile(client, input)

CreateUserProfile

delete_app!(client, input)

Same as delete_app/2 but raise on error

delete_app(client, input)

DeleteApp

delete_instance!(client, input)

Same as delete_instance/2 but raise on error

delete_instance(client, input)

DeleteInstance

delete_layer!(client, input)

Same as delete_layer/2 but raise on error

delete_layer(client, input)

DeleteLayer

delete_stack!(client, input)

Same as delete_stack/2 but raise on error

delete_stack(client, input)

DeleteStack

delete_user_profile!(client, input)

Same as delete_user_profile/2 but raise on error

delete_user_profile(client, input)

DeleteUserProfile

deregister_ecs_cluster!(client, input)

Same as deregister_ecs_cluster/2 but raise on error

deregister_ecs_cluster(client, input)

DeregisterEcsCluster

deregister_elastic_ip!(client, input)

Same as deregister_elastic_ip/2 but raise on error

deregister_elastic_ip(client, input)

DeregisterElasticIp

deregister_instance!(client, input)

Same as deregister_instance/2 but raise on error

deregister_instance(client, input)

DeregisterInstance

deregister_rds_db_instance!(client, input)

Same as deregister_rds_db_instance/2 but raise on error

deregister_rds_db_instance(client, input)

DeregisterRdsDbInstance

deregister_volume!(client, input)

Same as deregister_volume/2 but raise on error

deregister_volume(client, input)

DeregisterVolume

describe_agent_versions!(client, input)

Same as describe_agent_versions/2 but raise on error

describe_agent_versions(client, input)

DescribeAgentVersions

describe_apps!(client, input)

Same as describe_apps/2 but raise on error

describe_apps(client, input)

DescribeApps

describe_commands!(client, input)

Same as describe_commands/2 but raise on error

describe_commands(client, input)

DescribeCommands

describe_deployments!(client, input)

Same as describe_deployments/2 but raise on error

describe_deployments(client, input)

DescribeDeployments

describe_ecs_clusters!(client, input)

Same as describe_ecs_clusters/2 but raise on error

describe_ecs_clusters(client, input)

DescribeEcsClusters

describe_elastic_ips!(client, input)

Same as describe_elastic_ips/2 but raise on error

describe_elastic_ips(client, input)

DescribeElasticIps

describe_elastic_load_balancers!(client, input)

Same as describe_elastic_load_balancers/2 but raise on error

describe_elastic_load_balancers(client, input)

DescribeElasticLoadBalancers

describe_instances!(client, input)

Same as describe_instances/2 but raise on error

describe_instances(client, input)

DescribeInstances

describe_layers!(client, input)

Same as describe_layers/2 but raise on error

describe_layers(client, input)

DescribeLayers

describe_load_based_auto_scaling!(client, input)

Same as describe_load_based_auto_scaling/2 but raise on error

describe_load_based_auto_scaling(client, input)

DescribeLoadBasedAutoScaling

describe_my_user_profile!(client)

Same as describe_my_user_profile/2 but raise on error

describe_my_user_profile(client)

DescribeMyUserProfile

describe_permissions!(client, input)

Same as describe_permissions/2 but raise on error

describe_permissions(client, input)

DescribePermissions

describe_raid_arrays!(client, input)

Same as describe_raid_arrays/2 but raise on error

describe_raid_arrays(client, input)

DescribeRaidArrays

describe_rds_db_instances!(client, input)

Same as describe_rds_db_instances/2 but raise on error

describe_rds_db_instances(client, input)

DescribeRdsDbInstances

describe_service_errors!(client, input)

Same as describe_service_errors/2 but raise on error

describe_service_errors(client, input)

DescribeServiceErrors

describe_stack_provisioning_parameters!(client, input)

Same as describe_stack_provisioning_parameters/2 but raise on error

describe_stack_provisioning_parameters(client, input)

DescribeStackProvisioningParameters

describe_stack_summary!(client, input)

Same as describe_stack_summary/2 but raise on error

describe_stack_summary(client, input)

DescribeStackSummary

describe_stacks!(client, input)

Same as describe_stacks/2 but raise on error

describe_stacks(client, input)

DescribeStacks

describe_time_based_auto_scaling!(client, input)

Same as describe_time_based_auto_scaling/2 but raise on error

describe_time_based_auto_scaling(client, input)

DescribeTimeBasedAutoScaling

describe_user_profiles!(client, input)

Same as describe_user_profiles/2 but raise on error

describe_user_profiles(client, input)

DescribeUserProfiles

describe_volumes!(client, input)

Same as describe_volumes/2 but raise on error

describe_volumes(client, input)

DescribeVolumes

detach_elastic_load_balancer!(client, input)

Same as detach_elastic_load_balancer/2 but raise on error

detach_elastic_load_balancer(client, input)

DetachElasticLoadBalancer

disassociate_elastic_ip!(client, input)

Same as disassociate_elastic_ip/2 but raise on error

disassociate_elastic_ip(client, input)

DisassociateElasticIp

get_hostname_suggestion!(client, input)

Same as get_hostname_suggestion/2 but raise on error

get_hostname_suggestion(client, input)

GetHostnameSuggestion

grant_access!(client, input)

Same as grant_access/2 but raise on error

grant_access(client, input)

GrantAccess

reboot_instance!(client, input)

Same as reboot_instance/2 but raise on error

reboot_instance(client, input)

RebootInstance

register_ecs_cluster!(client, input)

Same as register_ecs_cluster/2 but raise on error

register_ecs_cluster(client, input)

RegisterEcsCluster

register_elastic_ip!(client, input)

Same as register_elastic_ip/2 but raise on error

register_elastic_ip(client, input)

RegisterElasticIp

register_instance!(client, input)

Same as register_instance/2 but raise on error

register_instance(client, input)

RegisterInstance

register_rds_db_instance!(client, input)

Same as register_rds_db_instance/2 but raise on error

register_rds_db_instance(client, input)

RegisterRdsDbInstance

register_volume!(client, input)

Same as register_volume/2 but raise on error

register_volume(client, input)

RegisterVolume

set_load_based_auto_scaling!(client, input)

Same as set_load_based_auto_scaling/2 but raise on error

set_load_based_auto_scaling(client, input)

SetLoadBasedAutoScaling

set_permission!(client, input)

Same as set_permission/2 but raise on error

set_permission(client, input)

SetPermission

set_time_based_auto_scaling!(client, input)

Same as set_time_based_auto_scaling/2 but raise on error

set_time_based_auto_scaling(client, input)

SetTimeBasedAutoScaling

start_instance!(client, input)

Same as start_instance/2 but raise on error

start_instance(client, input)

StartInstance

start_stack!(client, input)

Same as start_stack/2 but raise on error

start_stack(client, input)

StartStack

stop_instance!(client, input)

Same as stop_instance/2 but raise on error

stop_instance(client, input)

StopInstance

stop_stack!(client, input)

Same as stop_stack/2 but raise on error

stop_stack(client, input)

StopStack

unassign_instance!(client, input)

Same as unassign_instance/2 but raise on error

unassign_instance(client, input)

UnassignInstance

unassign_volume!(client, input)

Same as unassign_volume/2 but raise on error

unassign_volume(client, input)

UnassignVolume

update_app!(client, input)

Same as update_app/2 but raise on error

update_app(client, input)

UpdateApp

update_elastic_ip!(client, input)

Same as update_elastic_ip/2 but raise on error

update_elastic_ip(client, input)

UpdateElasticIp

update_instance!(client, input)

Same as update_instance/2 but raise on error

update_instance(client, input)

UpdateInstance

update_layer!(client, input)

Same as update_layer/2 but raise on error

update_layer(client, input)

UpdateLayer

update_my_user_profile!(client, input)

Same as update_my_user_profile/2 but raise on error

update_my_user_profile(client, input)

UpdateMyUserProfile

update_rds_db_instance!(client, input)

Same as update_rds_db_instance/2 but raise on error

update_rds_db_instance(client, input)

UpdateRdsDbInstance

update_stack!(client, input)

Same as update_stack/2 but raise on error

update_stack(client, input)

UpdateStack

update_user_profile!(client, input)

Same as update_user_profile/2 but raise on error

update_user_profile(client, input)

UpdateUserProfile

update_volume!(client, input)

Same as update_volume/2 but raise on error

update_volume(client, input)

UpdateVolume

Types

assign_instance_request :: [instance_id: binary, layer_ids: strings]

describe_stacks_result :: [{:stacks, stacks}]

stack_configuration_manager :: [name: binary, version: binary]

describe_volumes_request :: [instance_id: binary, raid_array_id: binary, stack_id: binary, volume_ids: strings]

source_type :: binary

create_deployment_result :: [{:deployment_id, binary}]

detach_elastic_load_balancer_request :: [elastic_load_balancer_name: binary, layer_id: binary]

describe_elastic_ips_request :: [instance_id: binary, ips: strings, stack_id: binary]

create_user_profile_request :: [allow_self_management: boolean, iam_user_arn: binary, ssh_public_key: binary, ssh_username: binary]

reported_os :: [family: binary, name: binary, version: binary]

register_volume_result :: [{:volume_id, binary}]

update_app_request :: [app_id: binary, app_source: source, attributes: app_attributes, data_sources: data_sources, description: binary, domains: strings, enable_ssl: boolean, environment: environment_variables, name: binary, ssl_configuration: ssl_configuration, type: app_type]

deregister_ecs_cluster_request :: [{:ecs_cluster_arn, binary}]

register_elastic_ip_request :: [elastic_ip: binary, stack_id: binary]

describe_apps_request :: [app_ids: strings, stack_id: binary]

deregister_elastic_ip_request :: [{:elastic_ip, binary}]

user_profile :: [allow_self_management: boolean, iam_user_arn: binary, name: binary, ssh_public_key: binary, ssh_username: binary]

create_instance_request :: [agent_version: binary, ami_id: binary, architecture: architecture, auto_scaling_type: auto_scaling_type, availability_zone: binary, block_device_mappings: block_device_mappings, ebs_optimized: boolean, hostname: binary, install_updates_on_boot: boolean, instance_type: binary, layer_ids: strings, os: binary, root_device_type: root_device_type, ssh_key_name: binary, stack_id: binary, subnet_id: binary, virtualization_type: binary]

elastic_ip :: [domain: binary, instance_id: binary, ip: binary, name: binary, region: binary]

describe_commands_request :: [command_ids: strings, deployment_id: binary, instance_id: binary]

create_deployment_request :: [app_id: binary, command: deployment_command, comment: binary, custom_json: binary, instance_ids: strings, stack_id: binary]

describe_user_profiles_request :: [{:iam_user_arns, strings}]

unassign_volume_request :: [{:volume_id, binary}]

describe_ecs_clusters_result :: [ecs_clusters: ecs_clusters, next_token: binary]

create_user_profile_result :: [{:iam_user_arn, binary}]

layer :: [attributes: layer_attributes, auto_assign_elastic_ips: boolean, auto_assign_public_ips: boolean, created_at: date_time, custom_instance_profile_arn: binary, custom_json: binary, custom_recipes: recipes, custom_security_group_ids: strings, default_recipes: recipes, default_security_group_names: strings, enable_auto_healing: boolean, install_updates_on_boot: boolean, layer_id: binary, lifecycle_event_configuration: lifecycle_event_configuration, name: binary, packages: strings, shortname: binary, stack_id: binary, type: layer_type, use_ebs_optimized_instances: boolean, volume_configurations: volume_configurations]

auto_scaling_thresholds :: [alarms: strings, cpu_threshold: double, ignore_metrics_time: minute, instance_count: integer, load_threshold: double, memory_threshold: double, thresholds_wait_time: minute]

register_rds_db_instance_request :: [db_password: binary, db_user: binary, rds_db_instance_arn: binary, stack_id: binary]

create_stack_request :: [agent_version: binary, attributes: stack_attributes, chef_configuration: chef_configuration, configuration_manager: stack_configuration_manager, custom_cookbooks_source: source, custom_json: binary, default_availability_zone: binary, default_instance_profile_arn: binary, default_os: binary, default_root_device_type: root_device_type, default_ssh_key_name: binary, default_subnet_id: binary, hostname_theme: binary, name: binary, region: binary, service_role_arn: binary, use_custom_cookbooks: boolean, use_opsworks_security_groups: boolean, vpc_id: binary]

describe_apps_result :: [{:apps, apps}]

register_ecs_cluster_request :: [ecs_cluster_arn: binary, stack_id: binary]

set_permission_request :: [allow_ssh: boolean, allow_sudo: boolean, iam_user_arn: binary, level: binary, stack_id: binary]

stop_instance_request :: [{:instance_id, binary}]

describe_agent_versions_request :: [configuration_manager: stack_configuration_manager, stack_id: binary]

chef_configuration :: [berkshelf_version: binary, manage_berkshelf: boolean]

clone_stack_request :: [agent_version: binary, attributes: stack_attributes, chef_configuration: chef_configuration, clone_app_ids: strings, clone_permissions: boolean, configuration_manager: stack_configuration_manager, custom_cookbooks_source: source, custom_json: binary, default_availability_zone: binary, default_instance_profile_arn: binary, default_os: binary, default_root_device_type: root_device_type, default_ssh_key_name: binary, default_subnet_id: binary, hostname_theme: binary, name: binary, region: binary, service_role_arn: binary, source_stack_id: binary, use_custom_cookbooks: boolean, use_opsworks_security_groups: boolean, vpc_id: binary]

strings :: [binary]

deregister_volume_request :: [{:volume_id, binary}]

attach_elastic_load_balancer_request :: [elastic_load_balancer_name: binary, layer_id: binary]

elastic_load_balancer :: [availability_zones: strings, dns_name: binary, ec2_instance_ids: strings, elastic_load_balancer_name: binary, layer_id: binary, region: binary, stack_id: binary, subnet_ids: strings, vpc_id: binary]

layers :: [layer]

start_stack_request :: [{:stack_id, binary}]

describe_service_errors_request :: [instance_id: binary, service_error_ids: strings, stack_id: binary]

stack :: [agent_version: binary, arn: binary, attributes: stack_attributes, chef_configuration: chef_configuration, configuration_manager: stack_configuration_manager, created_at: date_time, custom_cookbooks_source: source, custom_json: binary, default_availability_zone: binary, default_instance_profile_arn: binary, default_os: binary, default_root_device_type: root_device_type, default_ssh_key_name: binary, default_subnet_id: binary, hostname_theme: binary, name: binary, region: binary, service_role_arn: binary, stack_id: binary, use_custom_cookbooks: boolean, use_opsworks_security_groups: boolean, vpc_id: binary]

describe_deployments_request :: [app_id: binary, deployment_ids: strings, stack_id: binary]

describe_stack_provisioning_parameters_result :: [agent_installer_url: binary, parameters: parameters]

shutdown_event_configuration :: [delay_until_elb_connections_drained: boolean, execution_timeout: integer]

describe_raid_arrays_request :: [instance_id: binary, raid_array_ids: strings, stack_id: binary]

associate_elastic_ip_request :: [elastic_ip: binary, instance_id: binary]

deployment :: [app_id: binary, command: deployment_command, comment: binary, completed_at: date_time, created_at: date_time, custom_json: binary, deployment_id: binary, duration: integer, iam_user_arn: binary, instance_ids: strings, stack_id: binary, status: binary]

describe_instances_request :: [instance_ids: strings, layer_id: binary, stack_id: binary]

minute :: integer

describe_layers_request :: [layer_ids: strings, stack_id: binary]

set_time_based_auto_scaling_request :: [auto_scaling_schedule: weekly_auto_scaling_schedule, instance_id: binary]

create_layer_result :: [{:layer_id, binary}]

rds_db_instance :: [address: binary, db_instance_identifier: binary, db_password: binary, db_user: binary, engine: binary, missing_on_rds: boolean, rds_db_instance_arn: binary, region: binary, stack_id: binary]

self_user_profile :: [iam_user_arn: binary, name: binary, ssh_public_key: binary, ssh_username: binary]

command :: [acknowledged_at: date_time, command_id: binary, completed_at: date_time, created_at: date_time, deployment_id: binary, exit_code: integer, instance_id: binary, log_url: binary, status: binary, type: binary]

assign_volume_request :: [instance_id: binary, volume_id: binary]

create_app_request :: [app_source: source, attributes: app_attributes, data_sources: data_sources, description: binary, domains: strings, enable_ssl: boolean, environment: environment_variables, name: binary, shortname: binary, ssl_configuration: ssl_configuration, stack_id: binary, type: app_type]

root_device_type :: binary

register_instance_result :: [{:instance_id, binary}]

update_layer_request :: [attributes: layer_attributes, auto_assign_elastic_ips: boolean, auto_assign_public_ips: boolean, custom_instance_profile_arn: binary, custom_json: binary, custom_recipes: recipes, custom_security_group_ids: strings, enable_auto_healing: boolean, install_updates_on_boot: boolean, layer_id: binary, lifecycle_event_configuration: lifecycle_event_configuration, name: binary, packages: strings, shortname: binary, use_ebs_optimized_instances: boolean, volume_configurations: volume_configurations]

delete_instance_request :: [delete_elastic_ip: boolean, delete_volumes: boolean, instance_id: binary]

grant_access_result :: [{:temporary_credential, temporary_credential}]

service_error :: [created_at: date_time, instance_id: binary, message: binary, service_error_id: binary, stack_id: binary, type: binary]

describe_layers_result :: [{:layers, layers}]

auto_scaling_type :: binary

validation_exception :: [{:message, binary}]

instance_identity :: [document: binary, signature: binary]

switch :: binary

stop_stack_request :: [{:stack_id, binary}]

get_hostname_suggestion_request :: [{:layer_id, binary}]

start_instance_request :: [{:instance_id, binary}]

double :: float

temporary_credential :: [instance_id: binary, password: binary, username: binary, valid_for_in_minutes: integer]

instances_count :: [assigning: integer, booting: integer, connection_lost: integer, deregistering: integer, online: integer, pending: integer, rebooting: integer, registered: integer, registering: integer, requested: integer, running_setup: integer, setup_failed: integer, shutting_down: integer, start_failed: integer, stopped: integer, stopping: integer, terminated: integer, terminating: integer, unassigning: integer]

register_volume_request :: [ec2_volume_id: binary, stack_id: binary]

disassociate_elastic_ip_request :: [{:elastic_ip, binary}]

update_instance_request :: [agent_version: binary, ami_id: binary, architecture: architecture, auto_scaling_type: auto_scaling_type, ebs_optimized: boolean, hostname: binary, install_updates_on_boot: boolean, instance_id: binary, instance_type: binary, layer_ids: strings, os: binary, ssh_key_name: binary]

hour :: binary

environment_variable :: [key: binary, secure: boolean, value: binary]

describe_elastic_load_balancers_request :: [layer_ids: strings, stack_id: binary]

load_based_auto_scaling_configuration :: [down_scaling: auto_scaling_thresholds, enable: boolean, layer_id: binary, up_scaling: auto_scaling_thresholds]

delete_layer_request :: [{:layer_id, binary}]

time_based_auto_scaling_configuration :: [auto_scaling_schedule: weekly_auto_scaling_schedule, instance_id: binary]

unassign_instance_request :: [{:instance_id, binary}]

resource_not_found_exception :: [{:message, binary}]

update_stack_request :: [agent_version: binary, attributes: stack_attributes, chef_configuration: chef_configuration, configuration_manager: stack_configuration_manager, custom_cookbooks_source: source, custom_json: binary, default_availability_zone: binary, default_instance_profile_arn: binary, default_os: binary, default_root_device_type: root_device_type, default_ssh_key_name: binary, default_subnet_id: binary, hostname_theme: binary, name: binary, service_role_arn: binary, stack_id: binary, use_custom_cookbooks: boolean, use_opsworks_security_groups: boolean]

register_ecs_cluster_result :: [{:ecs_cluster_arn, binary}]

describe_stack_summary_request :: [{:stack_id, binary}]

update_user_profile_request :: [allow_self_management: boolean, iam_user_arn: binary, ssh_public_key: binary, ssh_username: binary]

clone_stack_result :: [{:stack_id, binary}]

apps :: [app]

update_rds_db_instance_request :: [db_password: binary, db_user: binary, rds_db_instance_arn: binary]

create_instance_result :: [{:instance_id, binary}]

update_volume_request :: [mount_point: binary, name: binary, volume_id: binary]

agent_version :: [configuration_manager: stack_configuration_manager, version: binary]

describe_stacks_request :: [{:stack_ids, strings}]

raid_array :: [availability_zone: binary, created_at: date_time, device: binary, instance_id: binary, iops: integer, mount_point: binary, name: binary, number_of_disks: integer, raid_array_id: binary, raid_level: integer, size: integer, stack_id: binary, volume_type: binary]

ebs_block_device :: [delete_on_termination: boolean, iops: integer, snapshot_id: binary, volume_size: integer, volume_type: volume_type]

set_load_based_auto_scaling_request :: [down_scaling: auto_scaling_thresholds, enable: boolean, layer_id: binary, up_scaling: auto_scaling_thresholds]

create_app_result :: [{:app_id, binary}]

delete_app_request :: [{:app_id, binary}]

deregister_rds_db_instance_request :: [{:rds_db_instance_arn, binary}]

update_elastic_ip_request :: [elastic_ip: binary, name: binary]

register_elastic_ip_result :: [{:elastic_ip, binary}]

recipes :: [configure: strings, deploy: strings, setup: strings, shutdown: strings, undeploy: strings]

describe_rds_db_instances_request :: [rds_db_instance_arns: strings, stack_id: binary]

app :: [app_id: binary, app_source: source, attributes: app_attributes, created_at: binary, data_sources: data_sources, description: binary, domains: strings, enable_ssl: boolean, environment: environment_variables, name: binary, shortname: binary, ssl_configuration: ssl_configuration, stack_id: binary, type: app_type]

get_hostname_suggestion_result :: [hostname: binary, layer_id: binary]

grant_access_request :: [instance_id: binary, valid_for_in_minutes: valid_for_in_minutes]

update_my_user_profile_request :: [{:ssh_public_key, binary}]

parameters :: [{binary, binary}]

app_type :: binary

layer_type :: binary

describe_permissions_request :: [iam_user_arn: binary, stack_id: binary]

ecs_cluster :: [ecs_cluster_arn: binary, ecs_cluster_name: binary, registered_at: date_time, stack_id: binary]

volume_type :: binary

deregister_instance_request :: [{:instance_id, binary}]

describe_ecs_clusters_request :: [ecs_cluster_arns: strings, max_results: integer, next_token: binary, stack_id: binary]

permission :: [allow_ssh: boolean, allow_sudo: boolean, iam_user_arn: binary, level: binary, stack_id: binary]

describe_volumes_result :: [{:volumes, volumes}]

date_time :: binary

reboot_instance_request :: [{:instance_id, binary}]

delete_stack_request :: [{:stack_id, binary}]

source :: [password: binary, revision: binary, ssh_key: binary, type: source_type, url: binary, username: binary]

create_layer_request :: [attributes: layer_attributes, auto_assign_elastic_ips: boolean, auto_assign_public_ips: boolean, custom_instance_profile_arn: binary, custom_json: binary, custom_recipes: recipes, custom_security_group_ids: strings, enable_auto_healing: boolean, install_updates_on_boot: boolean, lifecycle_event_configuration: lifecycle_event_configuration, name: binary, packages: strings, shortname: binary, stack_id: binary, type: layer_type, use_ebs_optimized_instances: boolean, volume_configurations: volume_configurations]

volume_configuration :: [iops: integer, mount_point: binary, number_of_disks: integer, raid_level: integer, size: integer, volume_type: binary]

create_stack_result :: [{:stack_id, binary}]

stacks :: [stack]

stack_summary :: [apps_count: integer, arn: binary, instances_count: instances_count, layers_count: integer, name: binary, stack_id: binary]

data_source :: [arn: binary, database_name: binary, type: binary]

ssl_configuration :: [certificate: binary, chain: binary, private_key: binary]

delete_user_profile_request :: [{:iam_user_arn, binary}]

volume :: [availability_zone: binary, device: binary, ec2_volume_id: binary, instance_id: binary, iops: integer, mount_point: binary, name: binary, raid_array_id: binary, region: binary, size: integer, status: binary, volume_id: binary, volume_type: binary]

block_device_mapping :: [device_name: binary, ebs: ebs_block_device, no_device: binary, virtual_name: binary]

register_instance_request :: [hostname: binary, instance_identity: instance_identity, private_ip: binary, public_ip: binary, rsa_public_key: binary, rsa_public_key_fingerprint: binary, stack_id: binary]

architecture :: binary

instance :: [reported_os: reported_os, created_at: date_time, elastic_ip: binary, block_device_mappings: block_device_mappings, private_dns: binary, security_group_ids: strings, ssh_key_name: binary, instance_id: binary, os: binary, stack_id: binary, ami_id: binary, ec2_instance_id: binary, instance_profile_arn: binary, registered_by: binary, public_dns: binary, ssh_host_dsa_key_fingerprint: binary, public_ip: binary, hostname: binary, root_device_type: root_device_type, reported_agent_version: binary, platform: binary, auto_scaling_type: auto_scaling_type, install_updates_on_boot: boolean, availability_zone: binary, last_service_error_id: binary, status: binary, subnet_id: binary, agent_version: binary, ssh_host_rsa_key_fingerprint: binary, private_ip: binary, ecs_cluster_arn: binary, ecs_container_instance_arn: binary, root_device_volume_id: binary, ebs_optimized: boolean, layer_ids: strings, instance_type: binary, architecture: architecture, infrastructure_class: binary, virtualization_type: virtualization_type]

Functions

assign_instance(client, input)

Specs:

AssignInstance

Assign a registered instance to a layer.

  • You can assign registered on-premises instances to any layer type.

  • You can assign registered Amazon EC2 instances only to custom layers.

  • You cannot use this action with instances that were created with AWS OpsWorks.

Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
assign_instance!(client, input)

Specs:

  • assign_instance!(client :: ExAws.OpsWorks.t, input :: assign_instance_request) :: ExAws.Request.JSON.success_t | no_return

Same as assign_instance/2 but raise on error.

Source
assign_volume(client, input)

Specs:

  • assign_volume(client :: ExAws.OpsWorks.t, input :: assign_volume_request) :: ExAws.Request.JSON.response_t

AssignVolume

Assigns one of the stack’s registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
assign_volume!(client, input)

Specs:

  • assign_volume!(client :: ExAws.OpsWorks.t, input :: assign_volume_request) :: ExAws.Request.JSON.success_t | no_return

Same as assign_volume/2 but raise on error.

Source
associate_elastic_ip(client, input)

Specs:

AssociateElasticIp

Associates one of the stack’s registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
associate_elastic_ip!(client, input)

Specs:

Same as associate_elastic_ip/2 but raise on error.

Source
attach_elastic_load_balancer(client, input)

Specs:

AttachElasticLoadBalancer

Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.

Note: You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
attach_elastic_load_balancer!(client, input)

Specs:

Same as attach_elastic_load_balancer/2 but raise on error.

Source
clone_stack(client, input)

Specs:

  • clone_stack(client :: ExAws.OpsWorks.t, input :: clone_stack_request) :: ExAws.Request.JSON.response_t

CloneStack

Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
clone_stack!(client, input)

Specs:

  • clone_stack!(client :: ExAws.OpsWorks.t, input :: clone_stack_request) :: ExAws.Request.JSON.success_t | no_return

Same as clone_stack/2 but raise on error.

Source
create_app(client, input)

Specs:

  • create_app(client :: ExAws.OpsWorks.t, input :: create_app_request) :: ExAws.Request.JSON.response_t

CreateApp

Creates an app for a specified stack. For more information, see Creating Apps.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
create_app!(client, input)

Specs:

  • create_app!(client :: ExAws.OpsWorks.t, input :: create_app_request) :: ExAws.Request.JSON.success_t | no_return

Same as create_app/2 but raise on error.

Source
create_deployment(client, input)

Specs:

CreateDeployment

Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
create_deployment!(client, input)

Specs:

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

Same as create_deployment/2 but raise on error.

Source
create_instance(client, input)

Specs:

CreateInstance

Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
create_instance!(client, input)

Specs:

  • create_instance!(client :: ExAws.OpsWorks.t, input :: create_instance_request) :: ExAws.Request.JSON.success_t | no_return

Same as create_instance/2 but raise on error.

Source
create_layer(client, input)

Specs:

  • create_layer(client :: ExAws.OpsWorks.t, input :: create_layer_request) :: ExAws.Request.JSON.response_t

CreateLayer

Creates a layer. For more information, see How to Create a Layer.

Note: You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
create_layer!(client, input)

Specs:

  • create_layer!(client :: ExAws.OpsWorks.t, input :: create_layer_request) :: ExAws.Request.JSON.success_t | no_return

Same as create_layer/2 but raise on error.

Source
create_stack(client, input)

Specs:

  • create_stack(client :: ExAws.OpsWorks.t, input :: create_stack_request) :: ExAws.Request.JSON.response_t

CreateStack

Creates a new stack. For more information, see Create a New Stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
create_stack!(client, input)

Specs:

  • create_stack!(client :: ExAws.OpsWorks.t, input :: create_stack_request) :: ExAws.Request.JSON.success_t | no_return

Same as create_stack/2 but raise on error.

Source
create_user_profile(client, input)

Specs:

CreateUserProfile

Creates a new user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
create_user_profile!(client, input)

Specs:

Same as create_user_profile/2 but raise on error.

Source
delete_app(client, input)

Specs:

  • delete_app(client :: ExAws.OpsWorks.t, input :: delete_app_request) :: ExAws.Request.JSON.response_t

DeleteApp

Deletes a specified app.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
delete_app!(client, input)

Specs:

  • delete_app!(client :: ExAws.OpsWorks.t, input :: delete_app_request) :: ExAws.Request.JSON.success_t | no_return

Same as delete_app/2 but raise on error.

Source
delete_instance(client, input)

Specs:

DeleteInstance

Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.

For more information, see Deleting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
delete_instance!(client, input)

Specs:

  • delete_instance!(client :: ExAws.OpsWorks.t, input :: delete_instance_request) :: ExAws.Request.JSON.success_t | no_return

Same as delete_instance/2 but raise on error.

Source
delete_layer(client, input)

Specs:

  • delete_layer(client :: ExAws.OpsWorks.t, input :: delete_layer_request) :: ExAws.Request.JSON.response_t

DeleteLayer

Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
delete_layer!(client, input)

Specs:

  • delete_layer!(client :: ExAws.OpsWorks.t, input :: delete_layer_request) :: ExAws.Request.JSON.success_t | no_return

Same as delete_layer/2 but raise on error.

Source
delete_stack(client, input)

Specs:

  • delete_stack(client :: ExAws.OpsWorks.t, input :: delete_stack_request) :: ExAws.Request.JSON.response_t

DeleteStack

Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
delete_stack!(client, input)

Specs:

  • delete_stack!(client :: ExAws.OpsWorks.t, input :: delete_stack_request) :: ExAws.Request.JSON.success_t | no_return

Same as delete_stack/2 but raise on error.

Source
delete_user_profile(client, input)

Specs:

DeleteUserProfile

Deletes a user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
delete_user_profile!(client, input)

Specs:

Same as delete_user_profile/2 but raise on error.

Source
deregister_ecs_cluster(client, input)

Specs:

DeregisterEcsCluster

Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"`.

Source
deregister_ecs_cluster!(client, input)

Specs:

Same as deregister_ecs_cluster/2 but raise on error.

Source
deregister_elastic_ip(client, input)

Specs:

DeregisterElasticIp

Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
deregister_elastic_ip!(client, input)

Specs:

Same as deregister_elastic_ip/2 but raise on error.

Source
deregister_instance(client, input)

Specs:

DeregisterInstance

Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
deregister_instance!(client, input)

Specs:

Same as deregister_instance/2 but raise on error.

Source
deregister_rds_db_instance(client, input)

Specs:

DeregisterRdsDbInstance

Deregisters an Amazon RDS instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
deregister_rds_db_instance!(client, input)

Specs:

Same as deregister_rds_db_instance/2 but raise on error.

Source
deregister_volume(client, input)

Specs:

DeregisterVolume

Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
deregister_volume!(client, input)

Specs:

  • deregister_volume!(client :: ExAws.OpsWorks.t, input :: deregister_volume_request) :: ExAws.Request.JSON.success_t | no_return

Same as deregister_volume/2 but raise on error.

Source
describe_agent_versions(client, input)

Specs:

DescribeAgentVersions

Describes the available AWS OpsWorks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager.

Source
describe_agent_versions!(client, input)

Specs:

Same as describe_agent_versions/2 but raise on error.

Source
describe_apps(client, input)

Specs:

  • describe_apps(client :: ExAws.OpsWorks.t, input :: describe_apps_request) :: ExAws.Request.JSON.response_t

DescribeApps

Requests a description of a specified set of apps.

Note: You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_apps!(client, input)

Specs:

  • describe_apps!(client :: ExAws.OpsWorks.t, input :: describe_apps_request) :: ExAws.Request.JSON.success_t | no_return

Same as describe_apps/2 but raise on error.

Source
describe_commands(client, input)

Specs:

DescribeCommands

Describes the results of specified commands.

Note: You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_commands!(client, input)

Specs:

  • describe_commands!(client :: ExAws.OpsWorks.t, input :: describe_commands_request) :: ExAws.Request.JSON.success_t | no_return

Same as describe_commands/2 but raise on error.

Source
describe_deployments(client, input)

Specs:

DescribeDeployments

Requests a description of a specified set of deployments.

Note: You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_deployments!(client, input)

Specs:

Same as describe_deployments/2 but raise on error.

Source
describe_ecs_clusters(client, input)

Specs:

DescribeEcsClusters

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks currently supports only one cluster per layer, so the result set has a maximum of one element.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see Managing User Permissions.

Source
describe_ecs_clusters!(client, input)

Specs:

Same as describe_ecs_clusters/2 but raise on error.

Source
describe_elastic_ips(client, input)

Specs:

DescribeElasticIps

Describes Elastic IP addresses.

Note: You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_elastic_ips!(client, input)

Specs:

Same as describe_elastic_ips/2 but raise on error.

Source
describe_elastic_load_balancers(client, input)

Specs:

DescribeElasticLoadBalancers

Describes a stack’s Elastic Load Balancing instances.

Note: You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_elastic_load_balancers!(client, input)

Specs:

Same as describe_elastic_load_balancers/2 but raise on error.

Source
describe_instances(client, input)

Specs:

DescribeInstances

Requests a description of a set of instances.

Note: You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_instances!(client, input)

Specs:

  • describe_instances!(client :: ExAws.OpsWorks.t, input :: describe_instances_request) :: ExAws.Request.JSON.success_t | no_return

Same as describe_instances/2 but raise on error.

Source
describe_layers(client, input)

Specs:

DescribeLayers

Requests a description of one or more layers in a specified stack.

Note: You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_layers!(client, input)

Specs:

  • describe_layers!(client :: ExAws.OpsWorks.t, input :: describe_layers_request) :: ExAws.Request.JSON.success_t | no_return

Same as describe_layers/2 but raise on error.

Source
describe_load_based_auto_scaling(client, input)

Specs:

DescribeLoadBasedAutoScaling

Describes load-based auto scaling configurations for specified layers.

Note: You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_load_based_auto_scaling!(client, input)

Specs:

Same as describe_load_based_auto_scaling/2 but raise on error.

Source
describe_my_user_profile(client)

Specs:

  • describe_my_user_profile(client :: ExAws.OpsWorks.t) :: ExAws.Request.JSON.response_t

DescribeMyUserProfile

Describes a user’s SSH information.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_my_user_profile!(client)

Specs:

  • describe_my_user_profile!(client :: ExAws.OpsWorks.t) :: ExAws.Request.JSON.success_t | no_return

Same as describe_my_user_profile/2 but raise on error.

Source
describe_permissions(client, input)

Specs:

DescribePermissions

Describes the permissions for a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_permissions!(client, input)

Specs:

Same as describe_permissions/2 but raise on error.

Source
describe_raid_arrays(client, input)

Specs:

DescribeRaidArrays

Describe an instance’s RAID arrays.

Note: You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_raid_arrays!(client, input)

Specs:

Same as describe_raid_arrays/2 but raise on error.

Source
describe_rds_db_instances(client, input)

Specs:

DescribeRdsDbInstances

Describes Amazon RDS instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_rds_db_instances!(client, input)

Specs:

Same as describe_rds_db_instances/2 but raise on error.

Source
describe_service_errors(client, input)

Specs:

DescribeServiceErrors

Describes AWS OpsWorks service errors.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_service_errors!(client, input)

Specs:

Same as describe_service_errors/2 but raise on error.

Source
describe_stack_provisioning_parameters(client, input)

Specs:

DescribeStackProvisioningParameters

Requests a description of a stack’s provisioning parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_stack_provisioning_parameters!(client, input)

Specs:

Same as describe_stack_provisioning_parameters/2 but raise on error.

Source
describe_stack_summary(client, input)

Specs:

DescribeStackSummary

Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_stack_summary!(client, input)

Specs:

Same as describe_stack_summary/2 but raise on error.

Source
describe_stacks(client, input)

Specs:

DescribeStacks

Requests a description of one or more stacks.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_stacks!(client, input)

Specs:

  • describe_stacks!(client :: ExAws.OpsWorks.t, input :: describe_stacks_request) :: ExAws.Request.JSON.success_t | no_return

Same as describe_stacks/2 but raise on error.

Source
describe_time_based_auto_scaling(client, input)

Specs:

DescribeTimeBasedAutoScaling

Describes time-based auto scaling configurations for specified instances.

Note: You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_time_based_auto_scaling!(client, input)

Specs:

Same as describe_time_based_auto_scaling/2 but raise on error.

Source
describe_user_profiles(client, input)

Specs:

DescribeUserProfiles

Describe specified users.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_user_profiles!(client, input)

Specs:

Same as describe_user_profiles/2 but raise on error.

Source
describe_volumes(client, input)

Specs:

DescribeVolumes

Describes an instance’s Amazon EBS volumes.

Note: You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
describe_volumes!(client, input)

Specs:

  • describe_volumes!(client :: ExAws.OpsWorks.t, input :: describe_volumes_request) :: ExAws.Request.JSON.success_t | no_return

Same as describe_volumes/2 but raise on error.

Source
detach_elastic_load_balancer(client, input)

Specs:

DetachElasticLoadBalancer

Detaches a specified Elastic Load Balancing instance from its layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
detach_elastic_load_balancer!(client, input)

Specs:

Same as detach_elastic_load_balancer/2 but raise on error.

Source
disassociate_elastic_ip(client, input)

Specs:

DisassociateElasticIp

Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
disassociate_elastic_ip!(client, input)

Specs:

Same as disassociate_elastic_ip/2 but raise on error.

Source
get_hostname_suggestion(client, input)

Specs:

GetHostnameSuggestion

Gets a generated host name for the specified layer, based on the current host name theme.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
get_hostname_suggestion!(client, input)

Specs:

Same as get_hostname_suggestion/2 but raise on error.

Source
grant_access(client, input)

Specs:

  • grant_access(client :: ExAws.OpsWorks.t, input :: grant_access_request) :: ExAws.Request.JSON.response_t

GrantAccess

Note:This action can be used only with Windows stacks. Grants RDP access to a Windows instance for a specified time period.

Source
grant_access!(client, input)

Specs:

  • grant_access!(client :: ExAws.OpsWorks.t, input :: grant_access_request) :: ExAws.Request.JSON.success_t | no_return

Same as grant_access/2 but raise on error.

Source
reboot_instance(client, input)

Specs:

RebootInstance

Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
reboot_instance!(client, input)

Specs:

  • reboot_instance!(client :: ExAws.OpsWorks.t, input :: reboot_instance_request) :: ExAws.Request.JSON.success_t | no_return

Same as reboot_instance/2 but raise on error.

Source
register_ecs_cluster(client, input)

Specs:

RegisterEcsCluster

Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
register_ecs_cluster!(client, input)

Specs:

Same as register_ecs_cluster/2 but raise on error.

Source
register_elastic_ip(client, input)

Specs:

RegisterElasticIp

Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
register_elastic_ip!(client, input)

Specs:

Same as register_elastic_ip/2 but raise on error.

Source
register_instance(client, input)

Specs:

RegisterInstance

Registers instances with a specified stack that were created outside of AWS OpsWorks.

Note:We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
register_instance!(client, input)

Specs:

  • register_instance!(client :: ExAws.OpsWorks.t, input :: register_instance_request) :: ExAws.Request.JSON.success_t | no_return

Same as register_instance/2 but raise on error.

Source
register_rds_db_instance(client, input)

Specs:

RegisterRdsDbInstance

Registers an Amazon RDS instance with a stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
register_rds_db_instance!(client, input)

Specs:

Same as register_rds_db_instance/2 but raise on error.

Source
register_volume(client, input)

Specs:

RegisterVolume

Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
register_volume!(client, input)

Specs:

  • register_volume!(client :: ExAws.OpsWorks.t, input :: register_volume_request) :: ExAws.Request.JSON.success_t | no_return

Same as register_volume/2 but raise on error.

Source
set_load_based_auto_scaling(client, input)

Specs:

SetLoadBasedAutoScaling

Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.

Note: To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
set_load_based_auto_scaling!(client, input)

Specs:

Same as set_load_based_auto_scaling/2 but raise on error.

Source
set_permission(client, input)

Specs:

  • set_permission(client :: ExAws.OpsWorks.t, input :: set_permission_request) :: ExAws.Request.JSON.response_t

SetPermission

Specifies a user’s permissions. For more information, see Security and Permissions.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
set_permission!(client, input)

Specs:

  • set_permission!(client :: ExAws.OpsWorks.t, input :: set_permission_request) :: ExAws.Request.JSON.success_t | no_return

Same as set_permission/2 but raise on error.

Source
set_time_based_auto_scaling(client, input)

Specs:

SetTimeBasedAutoScaling

Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
set_time_based_auto_scaling!(client, input)

Specs:

Same as set_time_based_auto_scaling/2 but raise on error.

Source
start_instance(client, input)

Specs:

  • start_instance(client :: ExAws.OpsWorks.t, input :: start_instance_request) :: ExAws.Request.JSON.response_t

StartInstance

Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
start_instance!(client, input)

Specs:

  • start_instance!(client :: ExAws.OpsWorks.t, input :: start_instance_request) :: ExAws.Request.JSON.success_t | no_return

Same as start_instance/2 but raise on error.

Source
start_stack(client, input)

Specs:

  • start_stack(client :: ExAws.OpsWorks.t, input :: start_stack_request) :: ExAws.Request.JSON.response_t

StartStack

Starts a stack’s instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
start_stack!(client, input)

Specs:

  • start_stack!(client :: ExAws.OpsWorks.t, input :: start_stack_request) :: ExAws.Request.JSON.success_t | no_return

Same as start_stack/2 but raise on error.

Source
stop_instance(client, input)

Specs:

  • stop_instance(client :: ExAws.OpsWorks.t, input :: stop_instance_request) :: ExAws.Request.JSON.response_t

StopInstance

Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
stop_instance!(client, input)

Specs:

  • stop_instance!(client :: ExAws.OpsWorks.t, input :: stop_instance_request) :: ExAws.Request.JSON.success_t | no_return

Same as stop_instance/2 but raise on error.

Source
stop_stack(client, input)

Specs:

  • stop_stack(client :: ExAws.OpsWorks.t, input :: stop_stack_request) :: ExAws.Request.JSON.response_t

StopStack

Stops a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
stop_stack!(client, input)

Specs:

  • stop_stack!(client :: ExAws.OpsWorks.t, input :: stop_stack_request) :: ExAws.Request.JSON.success_t | no_return

Same as stop_stack/2 but raise on error.

Source
unassign_instance(client, input)

Specs:

UnassignInstance

Unassigns a registered instance from all of it’s layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
unassign_instance!(client, input)

Specs:

  • unassign_instance!(client :: ExAws.OpsWorks.t, input :: unassign_instance_request) :: ExAws.Request.JSON.success_t | no_return

Same as unassign_instance/2 but raise on error.

Source
unassign_volume(client, input)

Specs:

UnassignVolume

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
unassign_volume!(client, input)

Specs:

  • unassign_volume!(client :: ExAws.OpsWorks.t, input :: unassign_volume_request) :: ExAws.Request.JSON.success_t | no_return

Same as unassign_volume/2 but raise on error.

Source
update_app(client, input)

Specs:

  • update_app(client :: ExAws.OpsWorks.t, input :: update_app_request) :: ExAws.Request.JSON.response_t

UpdateApp

Updates a specified app.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
update_app!(client, input)

Specs:

  • update_app!(client :: ExAws.OpsWorks.t, input :: update_app_request) :: ExAws.Request.JSON.success_t | no_return

Same as update_app/2 but raise on error.

Source
update_elastic_ip(client, input)

Specs:

UpdateElasticIp

Updates a registered Elastic IP address’s name. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
update_elastic_ip!(client, input)

Specs:

  • update_elastic_ip!(client :: ExAws.OpsWorks.t, input :: update_elastic_ip_request) :: ExAws.Request.JSON.success_t | no_return

Same as update_elastic_ip/2 but raise on error.

Source
update_instance(client, input)

Specs:

UpdateInstance

Updates a specified instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
update_instance!(client, input)

Specs:

  • update_instance!(client :: ExAws.OpsWorks.t, input :: update_instance_request) :: ExAws.Request.JSON.success_t | no_return

Same as update_instance/2 but raise on error.

Source
update_layer(client, input)

Specs:

  • update_layer(client :: ExAws.OpsWorks.t, input :: update_layer_request) :: ExAws.Request.JSON.response_t

UpdateLayer

Updates a specified layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
update_layer!(client, input)

Specs:

  • update_layer!(client :: ExAws.OpsWorks.t, input :: update_layer_request) :: ExAws.Request.JSON.success_t | no_return

Same as update_layer/2 but raise on error.

Source
update_my_user_profile(client, input)

Specs:

UpdateMyUserProfile

Updates a user’s SSH public key.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
update_my_user_profile!(client, input)

Specs:

Same as update_my_user_profile/2 but raise on error.

Source
update_rds_db_instance(client, input)

Specs:

UpdateRdsDbInstance

Updates an Amazon RDS instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
update_rds_db_instance!(client, input)

Specs:

Same as update_rds_db_instance/2 but raise on error.

Source
update_stack(client, input)

Specs:

  • update_stack(client :: ExAws.OpsWorks.t, input :: update_stack_request) :: ExAws.Request.JSON.response_t

UpdateStack

Updates a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
update_stack!(client, input)

Specs:

  • update_stack!(client :: ExAws.OpsWorks.t, input :: update_stack_request) :: ExAws.Request.JSON.success_t | no_return

Same as update_stack/2 but raise on error.

Source
update_user_profile(client, input)

Specs:

UpdateUserProfile

Updates a specified user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
update_user_profile!(client, input)

Specs:

Same as update_user_profile/2 but raise on error.

Source
update_volume(client, input)

Specs:

  • update_volume(client :: ExAws.OpsWorks.t, input :: update_volume_request) :: ExAws.Request.JSON.response_t

UpdateVolume

Updates an Amazon EBS volume’s name or mount point. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Source
update_volume!(client, input)

Specs:

  • update_volume!(client :: ExAws.OpsWorks.t, input :: update_volume_request) :: ExAws.Request.JSON.success_t | no_return

Same as update_volume/2 but raise on error.

Source