Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.
AWS OpsWorks Stacks 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 Stacks 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:
AWS SDK for .NET
AWS SDK for PHP 2
Endpoints
AWS 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 AWS 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 create_stack,
clone_stack, or
update_stack we recommend you use the
ConfigurationManager parameter 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.
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.
opsworks(config = list(), credentials = list(), endpoint = NULL, region = NULL)A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- opsworks(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| assign_instance | Assign a registered instance to a layer |
| assign_volume | Assigns one of the stack's registered Amazon EBS volumes to a specified instance |
| associate_elastic_ip | Associates one of the stack's registered Elastic IP addresses with a specified instance |
| attach_elastic_load_balancer | Attaches an Elastic Load Balancing load balancer to a specified layer |
| clone_stack | Creates a clone of a specified stack |
| create_app | Creates an app for a specified stack |
| create_deployment | Runs deployment or stack commands |
| create_instance | Creates an instance in a specified stack |
| create_layer | Creates a layer |
| create_stack | Creates a new stack |
| create_user_profile | Creates a new user profile |
| delete_app | Deletes a specified app |
| delete_instance | Deletes a specified instance, which terminates the associated Amazon EC2 instance |
| delete_layer | Deletes a specified layer |
| delete_stack | Deletes a specified stack |
| delete_user_profile | Deletes a user profile |
| deregister_ecs_cluster | Deregisters a specified Amazon ECS cluster from a stack |
| deregister_elastic_ip | Deregisters a specified Elastic IP address |
| deregister_instance | Deregister a registered Amazon EC2 or on-premises instance |
| deregister_rds_db_instance | Deregisters an Amazon RDS instance |
| deregister_volume | Deregisters an Amazon EBS volume |
| describe_agent_versions | Describes the available AWS OpsWorks Stacks agent versions |
| describe_apps | Requests a description of a specified set of apps |
| describe_commands | Describes the results of specified commands |
| describe_deployments | Requests a description of a specified set of deployments |
| describe_ecs_clusters | Describes Amazon ECS clusters that are registered with a stack |
| describe_elastic_ips | Describes Elastic IP addresses |
| describe_elastic_load_balancers | Describes a stack's Elastic Load Balancing instances |
| describe_instances | Requests a description of a set of instances |
| describe_layers | Requests a description of one or more layers in a specified stack |
| describe_load_based_auto_scaling | Describes load-based auto scaling configurations for specified layers |
| describe_my_user_profile | Describes a user's SSH information |
| describe_operating_systems | Describes the operating systems that are supported by AWS OpsWorks Stacks |
| describe_permissions | Describes the permissions for a specified stack |
| describe_raid_arrays | Describe an instance's RAID arrays |
| describe_rds_db_instances | Describes Amazon RDS instances |
| describe_service_errors | Describes AWS OpsWorks Stacks service errors |
| describe_stack_provisioning_parameters | Requests a description of a stack's provisioning parameters |
| describe_stacks | Requests a description of one or more stacks |
| describe_stack_summary | 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 |
| describe_time_based_auto_scaling | Describes time-based auto scaling configurations for specified instances |
| describe_user_profiles | Describe specified users |
| describe_volumes | Describes an instance's Amazon EBS volumes |
| detach_elastic_load_balancer | Detaches a specified Elastic Load Balancing instance from its layer |
| disassociate_elastic_ip | Disassociates an Elastic IP address from its instance |
| get_hostname_suggestion | Gets a generated host name for the specified layer, based on the current host name theme |
| grant_access | This action can be used only with Windows stacks |
| list_tags | Returns a list of tags that are applied to the specified stack or layer |
| reboot_instance | Reboots a specified instance |
| register_ecs_cluster | Registers a specified Amazon ECS cluster with a stack |
| register_elastic_ip | Registers an Elastic IP address with a specified stack |
| register_instance | Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack |
| register_rds_db_instance | Registers an Amazon RDS instance with a stack |
| register_volume | Registers an Amazon EBS volume with a specified stack |
| set_load_based_auto_scaling | Specify the load-based auto scaling configuration for a specified layer |
| set_permission | Specifies a user's permissions |
| set_time_based_auto_scaling | Specify the time-based auto scaling configuration for a specified instance |
| start_instance | Starts a specified instance |
| start_stack | Starts a stack's instances |
| stop_instance | Stops a specified instance |
| stop_stack | Stops a specified stack |
| tag_resource | Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks |
| unassign_instance | Unassigns a registered instance from all layers that are using the instance |
| unassign_volume | Unassigns an assigned Amazon EBS volume |
| untag_resource | Removes tags from a specified stack or layer |
| update_app | Updates a specified app |
| update_elastic_ip | Updates a registered Elastic IP address's name |
| update_instance | Updates a specified instance |
| update_layer | Updates a specified layer |
| update_my_user_profile | Updates a user's SSH public key |
| update_rds_db_instance | Updates an Amazon RDS instance |
| update_stack | Updates a specified stack |
| update_user_profile | Updates a specified user profile |
| update_volume | Updates an Amazon EBS volume's name or mount point |
if (FALSE) {
svc <- opsworks()
svc$assign_instance(
Foo = 123
)
}
Run the code above in your browser using DataLab