OpsWorks#
Client#
- class OpsWorks.Client#
A low-level client representing AWS OpsWorks
Welcome to the OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for OpsWorks Stacks actions and data types, including common parameters and error codes.
OpsWorks Stacks is an application management service that provides an integrated experience for managing the complete application lifecycle. For information about OpsWorks, see the OpsWorks information page.
SDKs and CLI
Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:
Endpoints
OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.
opsworks.us-east-1.amazonaws.com
opsworks.us-east-2.amazonaws.com
opsworks.us-west-1.amazonaws.com
opsworks.us-west-2.amazonaws.com
opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)
opsworks.eu-west-1.amazonaws.com
opsworks.eu-west-2.amazonaws.com
opsworks.eu-west-3.amazonaws.com
opsworks.eu-central-1.amazonaws.com
opsworks.ap-northeast-1.amazonaws.com
opsworks.ap-northeast-2.amazonaws.com
opsworks.ap-south-1.amazonaws.com
opsworks.ap-southeast-1.amazonaws.com
opsworks.ap-southeast-2.amazonaws.com
opsworks.sa-east-1.amazonaws.com
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we recommend you use the
ConfigurationManagerparameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.Note
You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.
client = session.create_client('opsworks')
These are the available methods:
- assign_instance
- assign_volume
- associate_elastic_ip
- attach_elastic_load_balancer
- can_paginate
- clone_stack
- close
- create_app
- create_deployment
- create_instance
- create_layer
- create_stack
- create_user_profile
- delete_app
- delete_instance
- delete_layer
- delete_stack
- delete_user_profile
- deregister_ecs_cluster
- deregister_elastic_ip
- deregister_instance
- deregister_rds_db_instance
- deregister_volume
- describe_agent_versions
- describe_apps
- describe_commands
- describe_deployments
- describe_ecs_clusters
- describe_elastic_ips
- describe_elastic_load_balancers
- describe_instances
- describe_layers
- describe_load_based_auto_scaling
- describe_my_user_profile
- describe_operating_systems
- describe_permissions
- describe_raid_arrays
- describe_rds_db_instances
- describe_service_errors
- describe_stack_provisioning_parameters
- describe_stack_summary
- describe_stacks
- describe_time_based_auto_scaling
- describe_user_profiles
- describe_volumes
- detach_elastic_load_balancer
- disassociate_elastic_ip
- get_hostname_suggestion
- get_paginator
- get_waiter
- grant_access
- list_tags
- reboot_instance
- register_ecs_cluster
- register_elastic_ip
- register_instance
- register_rds_db_instance
- register_volume
- set_load_based_auto_scaling
- set_permission
- set_time_based_auto_scaling
- start_instance
- start_stack
- stop_instance
- stop_stack
- tag_resource
- unassign_instance
- unassign_volume
- untag_resource
- update_app
- update_elastic_ip
- update_instance
- update_layer
- update_my_user_profile
- update_rds_db_instance
- update_stack
- update_user_profile
- update_volume
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are:
Waiters#
Waiters are available on a client instance via the get_waiter method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide.
The available waiters are: