{ "metadata":{ "apiVersion":"2013-02-18", "endpointPrefix":"opsworks", "jsonVersion":"1.1", "serviceFullName":"AWS OpsWorks", "signatureVersion":"v4", "targetPrefix":"OpsWorks_20130218", "protocol":"json" }, "documentation":"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, 0.9, 11.4, or 11.10. The default value is currently 11.10. For more information, see Chef Versions.

You can still specify Chef 0.9 for your stack, but new features are not available for Chef 0.9 stacks, and support is scheduled to end on July 24, 2014. 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.", "operations":{ "AssignInstance":{ "name":"AssignInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignInstanceRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Assign a registered instance to a custom layer. 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.

" }, "AssignVolume":{ "name":"AssignVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignVolumeRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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

" }, "AssociateElasticIp":{ "name":"AssociateElasticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateElasticIpRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "AttachElasticLoadBalancer":{ "name":"AttachElasticLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachElasticLoadBalancerRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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

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.

" }, "CloneStack":{ "name":"CloneStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CloneStackRequest"}, "output":{ "shape":"CloneStackResult", "documentation":"

Contains the response to a CloneStack request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Creates a clone of a specified stack. For more information, see Clone a 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.

" }, "CreateApp":{ "name":"CreateApp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAppRequest"}, "output":{ "shape":"CreateAppResult", "documentation":"

Contains the response to a CreateApp request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "CreateDeployment":{ "name":"CreateDeployment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDeploymentRequest"}, "output":{ "shape":"CreateDeploymentResult", "documentation":"

Contains the response to a CreateDeployment request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "CreateInstance":{ "name":"CreateInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceRequest"}, "output":{ "shape":"CreateInstanceResult", "documentation":"

Contains the response to a CreateInstance request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "CreateLayer":{ "name":"CreateLayer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLayerRequest"}, "output":{ "shape":"CreateLayerResult", "documentation":"

Contains the response to a CreateLayer request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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

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.

" }, "CreateStack":{ "name":"CreateStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateStackRequest"}, "output":{ "shape":"CreateStackResult", "documentation":"

Contains the response to a CreateStack request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" } ], "documentation":"

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.

" }, "CreateUserProfile":{ "name":"CreateUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateUserProfileRequest"}, "output":{ "shape":"CreateUserProfileResult", "documentation":"

Contains the response to a CreateUserProfile request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" } ], "documentation":"

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.

" }, "DeleteApp":{ "name":"DeleteApp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAppRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DeleteInstance":{ "name":"DeleteInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInstanceRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DeleteLayer":{ "name":"DeleteLayer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLayerRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DeleteStack":{ "name":"DeleteStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteStackRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DeleteUserProfile":{ "name":"DeleteUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteUserProfileRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DeregisterElasticIp":{ "name":"DeregisterElasticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterElasticIpRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DeregisterInstance":{ "name":"DeregisterInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterInstanceRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DeregisterRdsDbInstance":{ "name":"DeregisterRdsDbInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterRdsDbInstanceRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DeregisterVolume":{ "name":"DeregisterVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterVolumeRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DescribeApps":{ "name":"DescribeApps", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAppsRequest"}, "output":{ "shape":"DescribeAppsResult", "documentation":"

Contains the response to a DescribeApps request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Requests a description of a specified set of apps.

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.

" }, "DescribeCommands":{ "name":"DescribeCommands", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCommandsRequest"}, "output":{ "shape":"DescribeCommandsResult", "documentation":"

Contains the response to a DescribeCommands request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Describes the results of specified commands.

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.

" }, "DescribeDeployments":{ "name":"DescribeDeployments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDeploymentsRequest"}, "output":{ "shape":"DescribeDeploymentsResult", "documentation":"

Contains the response to a DescribeDeployments request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Requests a description of a specified set of deployments.

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.

" }, "DescribeElasticIps":{ "name":"DescribeElasticIps", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeElasticIpsRequest"}, "output":{ "shape":"DescribeElasticIpsResult", "documentation":"

Contains the response to a DescribeElasticIps request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Describes Elastic IP addresses.

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.

" }, "DescribeElasticLoadBalancers":{ "name":"DescribeElasticLoadBalancers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeElasticLoadBalancersRequest"}, "output":{ "shape":"DescribeElasticLoadBalancersResult", "documentation":"

Contains the response to a DescribeElasticLoadBalancers request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Describes a stack's Elastic Load Balancing instances.

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.

" }, "DescribeInstances":{ "name":"DescribeInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesRequest"}, "output":{ "shape":"DescribeInstancesResult", "documentation":"

Contains the response to a DescribeInstances request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Requests a description of a set of instances.

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.

" }, "DescribeLayers":{ "name":"DescribeLayers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLayersRequest"}, "output":{ "shape":"DescribeLayersResult", "documentation":"

Contains the response to a DescribeLayers request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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

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.

" }, "DescribeLoadBasedAutoScaling":{ "name":"DescribeLoadBasedAutoScaling", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLoadBasedAutoScalingRequest"}, "output":{ "shape":"DescribeLoadBasedAutoScalingResult", "documentation":"

Contains the response to a DescribeLoadBasedAutoScaling request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Describes load-based auto scaling configurations for specified layers.

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.

" }, "DescribeMyUserProfile":{ "name":"DescribeMyUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"DescribeMyUserProfileResult", "documentation":"

Contains the response to a DescribeMyUserProfile request.

" }, "documentation":"

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.

" }, "DescribePermissions":{ "name":"DescribePermissions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePermissionsRequest"}, "output":{ "shape":"DescribePermissionsResult", "documentation":"

Contains the response to a DescribePermissions request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DescribeRaidArrays":{ "name":"DescribeRaidArrays", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRaidArraysRequest"}, "output":{ "shape":"DescribeRaidArraysResult", "documentation":"

Contains the response to a DescribeRaidArrays request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Describe an instance's RAID arrays.

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.

" }, "DescribeRdsDbInstances":{ "name":"DescribeRdsDbInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRdsDbInstancesRequest"}, "output":{ "shape":"DescribeRdsDbInstancesResult", "documentation":"

Contains the response to a DescribeRdsDbInstances request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DescribeServiceErrors":{ "name":"DescribeServiceErrors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeServiceErrorsRequest"}, "output":{ "shape":"DescribeServiceErrorsResult", "documentation":"

Contains the response to a DescribeServiceErrors request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DescribeStackProvisioningParameters":{ "name":"DescribeStackProvisioningParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStackProvisioningParametersRequest"}, "output":{ "shape":"DescribeStackProvisioningParametersResult", "documentation":"

Contains the response to a DescribeStackProvisioningParameters request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DescribeStackSummary":{ "name":"DescribeStackSummary", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStackSummaryRequest"}, "output":{ "shape":"DescribeStackSummaryResult", "documentation":"

Contains the response to a DescribeStackSummary request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DescribeStacks":{ "name":"DescribeStacks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStacksRequest"}, "output":{ "shape":"DescribeStacksResult", "documentation":"

Contains the response to a DescribeStacks request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DescribeTimeBasedAutoScaling":{ "name":"DescribeTimeBasedAutoScaling", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTimeBasedAutoScalingRequest"}, "output":{ "shape":"DescribeTimeBasedAutoScalingResult", "documentation":"

Contains the response to a DescribeTimeBasedAutoScaling request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Describes time-based auto scaling configurations for specified instances.

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.

" }, "DescribeUserProfiles":{ "name":"DescribeUserProfiles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeUserProfilesRequest"}, "output":{ "shape":"DescribeUserProfilesResult", "documentation":"

Contains the response to a DescribeUserProfiles request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DescribeVolumes":{ "name":"DescribeVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumesRequest"}, "output":{ "shape":"DescribeVolumesResult", "documentation":"

Contains the response to a DescribeVolumes request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

Describes an instance's Amazon EBS volumes.

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.

" }, "DetachElasticLoadBalancer":{ "name":"DetachElasticLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachElasticLoadBalancerRequest"}, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "DisassociateElasticIp":{ "name":"DisassociateElasticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateElasticIpRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "GetHostnameSuggestion":{ "name":"GetHostnameSuggestion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetHostnameSuggestionRequest"}, "output":{ "shape":"GetHostnameSuggestionResult", "documentation":"

Contains the response to a GetHostnameSuggestion request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "RebootInstance":{ "name":"RebootInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootInstanceRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "RegisterElasticIp":{ "name":"RegisterElasticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterElasticIpRequest"}, "output":{ "shape":"RegisterElasticIpResult", "documentation":"

Contains the response to a RegisterElasticIp request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "RegisterInstance":{ "name":"RegisterInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterInstanceRequest"}, "output":{ "shape":"RegisterInstanceResult", "documentation":"

Contains the response to a RegisterInstanceResult request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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

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.

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.

" }, "RegisterRdsDbInstance":{ "name":"RegisterRdsDbInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterRdsDbInstanceRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "RegisterVolume":{ "name":"RegisterVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterVolumeRequest"}, "output":{ "shape":"RegisterVolumeResult", "documentation":"

Contains the response to a RegisterVolume request.

" }, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "SetLoadBasedAutoScaling":{ "name":"SetLoadBasedAutoScaling", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetLoadBasedAutoScalingRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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

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.

" }, "SetPermission":{ "name":"SetPermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetPermissionRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "SetTimeBasedAutoScaling":{ "name":"SetTimeBasedAutoScaling", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetTimeBasedAutoScalingRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "StartInstance":{ "name":"StartInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartInstanceRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "StartStack":{ "name":"StartStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartStackRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "StopInstance":{ "name":"StopInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopInstanceRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "StopStack":{ "name":"StopStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopStackRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "UnassignInstance":{ "name":"UnassignInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignInstanceRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "UnassignVolume":{ "name":"UnassignVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignVolumeRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "UpdateApp":{ "name":"UpdateApp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAppRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "UpdateElasticIp":{ "name":"UpdateElasticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateElasticIpRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "UpdateInstance":{ "name":"UpdateInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateInstanceRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "UpdateLayer":{ "name":"UpdateLayer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateLayerRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "UpdateMyUserProfile":{ "name":"UpdateMyUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateMyUserProfileRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" } ], "documentation":"

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.

" }, "UpdateRdsDbInstance":{ "name":"UpdateRdsDbInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRdsDbInstanceRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "UpdateStack":{ "name":"UpdateStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateStackRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "UpdateUserProfile":{ "name":"UpdateUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateUserProfileRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" }, "UpdateVolume":{ "name":"UpdateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateVolumeRequest"}, "errors":[ { "shape":"ValidationException", "exception":true, "documentation":"

Indicates that a request was invalid.

" }, { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

Indicates that a resource was not found.

" } ], "documentation":"

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.

" } }, "shapes":{ "App":{ "type":"structure", "members":{ "AppId":{ "shape":"String", "documentation":"

The app ID.

" }, "StackId":{ "shape":"String", "documentation":"

The app stack ID.

" }, "Shortname":{ "shape":"String", "documentation":"

The app's short name.

" }, "Name":{ "shape":"String", "documentation":"

The app name.

" }, "Description":{ "shape":"String", "documentation":"

A description of the app.

" }, "DataSources":{ "shape":"DataSources", "documentation":"

The app's data sources.

" }, "Type":{ "shape":"AppType", "documentation":"

The app type.

" }, "AppSource":{ "shape":"Source", "documentation":"

A Source object that describes the app repository.

" }, "Domains":{ "shape":"Strings", "documentation":"

The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'

" }, "EnableSsl":{ "shape":"Boolean", "documentation":"

Whether to enable SSL for the app.

" }, "SslConfiguration":{ "shape":"SslConfiguration", "documentation":"

An SslConfiguration object with the SSL configuration.

" }, "Attributes":{ "shape":"AppAttributes", "documentation":"

The stack attributes.

" }, "CreatedAt":{ "shape":"String", "documentation":"

When the app was created.

" }, "Environment":{ "shape":"EnvironmentVariables", "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. You can specify up to ten environment variables. After you deploy the app, these variables are defined on the associated app server instances.

" } }, "documentation":"

A description of the app.

" }, "AppAttributes":{ "type":"map", "key":{"shape":"AppAttributesKeys"}, "value":{"shape":"String"} }, "AppAttributesKeys":{ "type":"string", "enum":[ "DocumentRoot", "RailsEnv", "AutoBundleOnDeploy" ] }, "AppType":{ "type":"string", "enum":[ "java", "rails", "php", "nodejs", "static", "other" ] }, "Apps":{ "type":"list", "member":{"shape":"App"} }, "Architecture":{ "type":"string", "enum":[ "x86_64", "i386" ] }, "AssignInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "LayerIds" ], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.

" } } }, "AssignVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "AssociateElasticIpRequest":{ "type":"structure", "required":["ElasticIp"], "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP address.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "AttachElasticLoadBalancerRequest":{ "type":"structure", "required":[ "ElasticLoadBalancerName", "LayerId" ], "members":{ "ElasticLoadBalancerName":{ "shape":"String", "documentation":"

The Elastic Load Balancing instance's name.

" }, "LayerId":{ "shape":"String", "documentation":"

The ID of the layer that the Elastic Load Balancing instance is to be attached to.

" } } }, "AutoScalingThresholds":{ "type":"structure", "members":{ "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances to add or remove when the load exceeds a threshold.

" }, "ThresholdsWaitTime":{ "shape":"Minute", "documentation":"

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

" }, "IgnoreMetricsTime":{ "shape":"Minute", "documentation":"

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and not raise any additional scaling events. For example, AWS OpsWorks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks to not raise any scaling events long enough to get the new instances online.

" }, "CpuThreshold":{ "shape":"Double", "documentation":"

The CPU utilization threshold, as a percent of the available CPU.

" }, "MemoryThreshold":{ "shape":"Double", "documentation":"

The memory utilization threshold, as a percent of the available memory.

" }, "LoadThreshold":{ "shape":"Double", "documentation":"

The load threshold. For more information about how load is computed, see Load (computing).

" } }, "documentation":"

Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks starts or stops load-based instances.

" }, "AutoScalingType":{ "type":"string", "enum":[ "load", "timer" ] }, "Boolean":{ "type":"boolean", "box":true }, "ChefConfiguration":{ "type":"structure", "members":{ "ManageBerkshelf":{ "shape":"Boolean", "documentation":"

Whether to enable Berkshelf.

" }, "BerkshelfVersion":{ "shape":"String", "documentation":"

The Berkshelf version.

" } }, "documentation":"

Describes the Chef configuration.

" }, "CloneStackRequest":{ "type":"structure", "required":[ "SourceStackId", "ServiceRoleArn" ], "members":{ "SourceStackId":{ "shape":"String", "documentation":"

The source stack ID.

" }, "Name":{ "shape":"String", "documentation":"

The cloned stack name.

" }, "Region":{ "shape":"String", "documentation":"

The cloned stack AWS region, such as \"us-east-1\". For more information about AWS regions, see Regions and Endpoints.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.

" }, "Attributes":{ "shape":"StackAttributes", "documentation":"

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

" }, "ServiceRoleArn":{ "shape":"String", "documentation":"

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

" }, "DefaultInstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" }, "DefaultOs":{ "shape":"String", "documentation":"

The stacks's operating system, which must be set to one of the following.

The default option is the current Amazon Linux version.

" }, "HostnameTheme":{ "shape":"String", "documentation":"

The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" }, "DefaultAvailabilityZone":{ "shape":"String", "documentation":"

The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

" }, "DefaultSubnetId":{ "shape":"String", "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" }, "CustomJson":{ "shape":"String", "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON

" }, "ConfigurationManager":{ "shape":"StackConfigurationManager", "documentation":"

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.

" }, "ChefConfiguration":{ "shape":"ChefConfiguration", "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" }, "UseCustomCookbooks":{ "shape":"Boolean", "documentation":"

Whether to use custom cookbooks.

" }, "UseOpsworksSecurityGroups":{ "shape":"Boolean", "documentation":"

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

For more information, see Create a New Stack.

" }, "CustomCookbooksSource":{"shape":"Source"}, "DefaultSshKeyName":{ "shape":"String", "documentation":"

A default SSH key for the stack instances. You can override this value when you create or update an instance.

" }, "ClonePermissions":{ "shape":"Boolean", "documentation":"

Whether to clone the source stack's permissions.

" }, "CloneAppIds":{ "shape":"Strings", "documentation":"

A list of source stack app IDs to be included in the cloned stack.

" }, "DefaultRootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" } } }, "CloneStackResult":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The cloned stack ID.

" } }, "documentation":"

Contains the response to a CloneStack request.

" }, "Command":{ "type":"structure", "members":{ "CommandId":{ "shape":"String", "documentation":"

The command ID.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance where the command was executed.

" }, "DeploymentId":{ "shape":"String", "documentation":"

The command deployment ID.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

Date and time when the command was run.

" }, "AcknowledgedAt":{ "shape":"DateTime", "documentation":"

Date and time when the command was acknowledged.

" }, "CompletedAt":{ "shape":"DateTime", "documentation":"

Date when the command completed.

" }, "Status":{ "shape":"String", "documentation":"

The command status:

" }, "ExitCode":{ "shape":"Integer", "documentation":"

The command exit code.

" }, "LogUrl":{ "shape":"String", "documentation":"

The URL of the command log.

" }, "Type":{ "shape":"String", "documentation":"

The command type:

" } }, "documentation":"

Describes a command.

" }, "Commands":{ "type":"list", "member":{"shape":"Command"} }, "CreateAppRequest":{ "type":"structure", "required":[ "StackId", "Name", "Type" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "Shortname":{ "shape":"String", "documentation":"

The app's short name.

" }, "Name":{ "shape":"String", "documentation":"

The app name.

" }, "Description":{ "shape":"String", "documentation":"

A description of the app.

" }, "DataSources":{ "shape":"DataSources", "documentation":"

The app's data source.

" }, "Type":{ "shape":"AppType", "documentation":"

The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks deploys an application to those instances that are members of the corresponding layer.

" }, "AppSource":{ "shape":"Source", "documentation":"

A Source object that specifies the app repository.

" }, "Domains":{ "shape":"Strings", "documentation":"

The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

" }, "EnableSsl":{ "shape":"Boolean", "documentation":"

Whether to enable SSL for the app.

" }, "SslConfiguration":{ "shape":"SslConfiguration", "documentation":"

An SslConfiguration object with the SSL configuration.

" }, "Attributes":{ "shape":"AppAttributes", "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" }, "Environment":{ "shape":"EnvironmentVariables", "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. You can specify up to ten environment variables. After you deploy the app, these variables are defined on the associated app server instance.

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version." } } }, "CreateAppResult":{ "type":"structure", "members":{ "AppId":{ "shape":"String", "documentation":"

The app ID.

" } }, "documentation":"

Contains the response to a CreateApp request.

" }, "CreateDeploymentRequest":{ "type":"structure", "required":[ "StackId", "Command" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "AppId":{ "shape":"String", "documentation":"

The app ID. This parameter is required for app deployments, but not for other deployment commands.

" }, "InstanceIds":{ "shape":"Strings", "documentation":"

The instance IDs for the deployment targets.

" }, "Command":{ "shape":"DeploymentCommand", "documentation":"

A DeploymentCommand object that specifies the deployment command and any associated arguments.

" }, "Comment":{ "shape":"String", "documentation":"

A user-defined comment.

" }, "CustomJson":{ "shape":"String", "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

" } } }, "CreateDeploymentResult":{ "type":"structure", "members":{ "DeploymentId":{ "shape":"String", "documentation":"

The deployment ID, which can be used with other requests to identify the deployment.

" } }, "documentation":"

Contains the response to a CreateDeployment request.

" }, "CreateInstanceRequest":{ "type":"structure", "required":[ "StackId", "LayerIds", "InstanceType" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

An array that contains the instance layer IDs.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

" }, "AutoScalingType":{ "shape":"AutoScalingType", "documentation":"

For load-based or time-based instances, the type.

" }, "Hostname":{ "shape":"String", "documentation":"

The instance host name.

" }, "Os":{ "shape":"String", "documentation":"

The instance's operating system, which must be set to one of the following.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

" }, "AmiId":{ "shape":"String", "documentation":"

A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks AMIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances.

If you specify a custom AMI, you must set Os to Custom." }, "SshKeyName":{ "shape":"String", "documentation":"

The instance SSH key name.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The instance Availability Zone. For more information, see Regions and Endpoints.

" }, "VirtualizationType":{ "shape":"String", "documentation":"

The instance's virtualization type, paravirtual or hvm.

" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet.

" }, "Architecture":{ "shape":"Architecture", "documentation":"

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

" }, "RootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The instance root device type. For more information, see Storage for the Root Device.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Whether to create an Amazon EBS-optimized instance.

" } } }, "CreateInstanceResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } }, "documentation":"

Contains the response to a CreateInstance request.

" }, "CreateLayerRequest":{ "type":"structure", "required":[ "StackId", "Type", "Name", "Shortname" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The layer stack ID.

" }, "Type":{ "shape":"LayerType", "documentation":"

The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.

" }, "Name":{ "shape":"String", "documentation":"

The layer name, which is used by the console.

" }, "Shortname":{ "shape":"String", "documentation":"

The layer short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

" }, "Attributes":{ "shape":"LayerAttributes", "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" }, "CustomInstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of an IAM profile that to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" }, "CustomSecurityGroupIds":{ "shape":"Strings", "documentation":"

An array containing the layer custom security group IDs.

" }, "Packages":{ "shape":"Strings", "documentation":"

An array of Package objects that describe the layer packages.

" }, "VolumeConfigurations":{ "shape":"VolumeConfigurations", "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" }, "EnableAutoHealing":{ "shape":"Boolean", "documentation":"

Whether to disable auto healing for the layer.

" }, "AutoAssignElasticIps":{ "shape":"Boolean", "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "AutoAssignPublicIps":{ "shape":"Boolean", "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "CustomRecipes":{ "shape":"Recipes", "documentation":"

A LayerCustomRecipes object that specifies the layer custom recipes.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" }, "UseEbsOptimizedInstances":{ "shape":"Boolean", "documentation":"

Whether to use Amazon EBS-optimized instances.

" }, "LifecycleEventConfiguration":{ "shape":"LifecycleEventConfiguration", "documentation":"

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

" } } }, "CreateLayerResult":{ "type":"structure", "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" } }, "documentation":"

Contains the response to a CreateLayer request.

" }, "CreateStackRequest":{ "type":"structure", "required":[ "Name", "Region", "ServiceRoleArn", "DefaultInstanceProfileArn" ], "members":{ "Name":{ "shape":"String", "documentation":"

The stack name.

" }, "Region":{ "shape":"String", "documentation":"

The stack AWS region, such as \"us-east-1\". For more information about Amazon regions, see Regions and Endpoints.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC that the stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.

" }, "Attributes":{ "shape":"StackAttributes", "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" }, "ServiceRoleArn":{ "shape":"String", "documentation":"

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.

" }, "DefaultInstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" }, "DefaultOs":{ "shape":"String", "documentation":"

The stack's operating system, which must be set to one of the following.

The default option is the current Amazon Linux version.

" }, "HostnameTheme":{ "shape":"String", "documentation":"

The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" }, "DefaultAvailabilityZone":{ "shape":"String", "documentation":"

The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

" }, "DefaultSubnetId":{ "shape":"String", "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" }, "CustomJson":{ "shape":"String", "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

" }, "ConfigurationManager":{ "shape":"StackConfigurationManager", "documentation":"

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.

" }, "ChefConfiguration":{ "shape":"ChefConfiguration", "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" }, "UseCustomCookbooks":{ "shape":"Boolean", "documentation":"

Whether the stack uses custom cookbooks.

" }, "UseOpsworksSecurityGroups":{ "shape":"Boolean", "documentation":"

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

For more information, see Create a New Stack.

" }, "CustomCookbooksSource":{"shape":"Source"}, "DefaultSshKeyName":{ "shape":"String", "documentation":"

A default SSH key for the stack instances. You can override this value when you create or update an instance.

" }, "DefaultRootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.

" } } }, "CreateStackResult":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks.

" } }, "documentation":"

Contains the response to a CreateStack request.

" }, "CreateUserProfileRequest":{ "type":"structure", "required":["IamUserArn"], "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN.

" }, "SshUsername":{ "shape":"String", "documentation":"

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.

" }, "SshPublicKey":{ "shape":"String", "documentation":"

The user's public SSH key.

" }, "AllowSelfManagement":{ "shape":"Boolean", "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.

" } } }, "CreateUserProfileResult":{ "type":"structure", "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN.

" } }, "documentation":"

Contains the response to a CreateUserProfile request.

" }, "DailyAutoScalingSchedule":{ "type":"map", "key":{"shape":"Hour"}, "value":{"shape":"Switch"} }, "DataSource":{ "type":"structure", "members":{ "Type":{ "shape":"String", "documentation":"

The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, or RdsDbInstance.

" }, "Arn":{ "shape":"String", "documentation":"

The data source's ARN.

" }, "DatabaseName":{ "shape":"String", "documentation":"

The database name.

" } }, "documentation":"

Describes an app's data source.

" }, "DataSources":{ "type":"list", "member":{"shape":"DataSource"} }, "DateTime":{"type":"string"}, "DeleteAppRequest":{ "type":"structure", "required":["AppId"], "members":{ "AppId":{ "shape":"String", "documentation":"

The app ID.

" } } }, "DeleteInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "DeleteElasticIp":{ "shape":"Boolean", "documentation":"

Whether to delete the instance Elastic IP address.

" }, "DeleteVolumes":{ "shape":"Boolean", "documentation":"

Whether to delete the instance's Amazon EBS volumes.

" } } }, "DeleteLayerRequest":{ "type":"structure", "required":["LayerId"], "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" } } }, "DeleteStackRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "DeleteUserProfileRequest":{ "type":"structure", "required":["IamUserArn"], "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN.

" } } }, "Deployment":{ "type":"structure", "members":{ "DeploymentId":{ "shape":"String", "documentation":"

The deployment ID.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "AppId":{ "shape":"String", "documentation":"

The app ID.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

Date when the deployment was created.

" }, "CompletedAt":{ "shape":"DateTime", "documentation":"

Date when the deployment completed.

" }, "Duration":{ "shape":"Integer", "documentation":"

The deployment duration.

" }, "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN.

" }, "Comment":{ "shape":"String", "documentation":"

A user-defined comment.

" }, "Command":{"shape":"DeploymentCommand"}, "Status":{ "shape":"String", "documentation":"

The deployment status:

" }, "CustomJson":{ "shape":"String", "documentation":"

A string that contains user-defined custom JSON. It is used to override the corresponding default stack configuration JSON values for stack. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

" }, "InstanceIds":{ "shape":"Strings", "documentation":"

The IDs of the target instances.

" } }, "documentation":"

Describes a deployment of a stack or app.

" }, "DeploymentCommand":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DeploymentCommandName", "documentation":"

Specifies the operation. You can specify only one command.

For stacks, the following commands are available:

For apps, the following commands are available:

" }, "Args":{ "shape":"DeploymentCommandArgs", "documentation":"

The arguments of those commands that take arguments. It should be set to a JSON object with the following format:

{\"arg_name1\" : [\"value1\", \"value2\", ...], \"arg_name2\" : [\"value1\", \"value2\", ...], ...}

The update_dependencies command takes two arguments:

For example, to upgrade an instance to Amazon Linux 2014.09, set Args to the following.

{ \"upgrade_os_to\":[\"Amazon Linux 2014.09\"], \"allow_reboot\":[\"true\"] } " } }, "documentation":"

Used to specify a stack or deployment command.

" }, "DeploymentCommandArgs":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"Strings"} }, "DeploymentCommandName":{ "type":"string", "enum":[ "install_dependencies", "update_dependencies", "update_custom_cookbooks", "execute_recipes", "deploy", "rollback", "start", "stop", "restart", "undeploy" ] }, "Deployments":{ "type":"list", "member":{"shape":"Deployment"} }, "DeregisterElasticIpRequest":{ "type":"structure", "required":["ElasticIp"], "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP address.

" } } }, "DeregisterInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "DeregisterRdsDbInstanceRequest":{ "type":"structure", "required":["RdsDbInstanceArn"], "members":{ "RdsDbInstanceArn":{ "shape":"String", "documentation":"

The Amazon RDS instance's ARN.

" } } }, "DeregisterVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

" } } }, "DescribeAppsRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

" }, "AppIds":{ "shape":"Strings", "documentation":"

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

" } } }, "DescribeAppsResult":{ "type":"structure", "members":{ "Apps":{ "shape":"Apps", "documentation":"

An array of App objects that describe the specified apps.

" } }, "documentation":"

Contains the response to a DescribeApps request.

" }, "DescribeCommandsRequest":{ "type":"structure", "members":{ "DeploymentId":{ "shape":"String", "documentation":"

The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.

" }, "CommandIds":{ "shape":"Strings", "documentation":"

An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.

" } } }, "DescribeCommandsResult":{ "type":"structure", "members":{ "Commands":{ "shape":"Commands", "documentation":"

An array of Command objects that describe each of the specified commands.

" } }, "documentation":"

Contains the response to a DescribeCommands request.

" }, "DescribeDeploymentsRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

" }, "AppId":{ "shape":"String", "documentation":"

The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

" }, "DeploymentIds":{ "shape":"Strings", "documentation":"

An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

" } } }, "DescribeDeploymentsResult":{ "type":"structure", "members":{ "Deployments":{ "shape":"Deployments", "documentation":"

An array of Deployment objects that describe the deployments.

" } }, "documentation":"

Contains the response to a DescribeDeployments request.

" }, "DescribeElasticIpsRequest":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

" }, "StackId":{ "shape":"String", "documentation":"

A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

" }, "Ips":{ "shape":"Strings", "documentation":"

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

" } } }, "DescribeElasticIpsResult":{ "type":"structure", "members":{ "ElasticIps":{ "shape":"ElasticIps", "documentation":"

An ElasticIps object that describes the specified Elastic IP addresses.

" } }, "documentation":"

Contains the response to a DescribeElasticIps request.

" }, "DescribeElasticLoadBalancersRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

A stack ID. The action describes the stack's Elastic Load Balancing instances.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

" } } }, "DescribeElasticLoadBalancersResult":{ "type":"structure", "members":{ "ElasticLoadBalancers":{ "shape":"ElasticLoadBalancers", "documentation":"

A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.

" } }, "documentation":"

Contains the response to a DescribeElasticLoadBalancers request.

" }, "DescribeInstancesRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

" }, "LayerId":{ "shape":"String", "documentation":"

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

" }, "InstanceIds":{ "shape":"Strings", "documentation":"

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

" } } }, "DescribeInstancesResult":{ "type":"structure", "members":{ "Instances":{ "shape":"Instances", "documentation":"

An array of Instance objects that describe the instances.

" } }, "documentation":"

Contains the response to a DescribeInstances request.

" }, "DescribeLayersRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

" } } }, "DescribeLayersResult":{ "type":"structure", "members":{ "Layers":{ "shape":"Layers", "documentation":"

An array of Layer objects that describe the layers.

" } }, "documentation":"

Contains the response to a DescribeLayers request.

" }, "DescribeLoadBasedAutoScalingRequest":{ "type":"structure", "required":["LayerIds"], "members":{ "LayerIds":{ "shape":"Strings", "documentation":"

An array of layer IDs.

" } } }, "DescribeLoadBasedAutoScalingResult":{ "type":"structure", "members":{ "LoadBasedAutoScalingConfigurations":{ "shape":"LoadBasedAutoScalingConfigurations", "documentation":"

An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.

" } }, "documentation":"

Contains the response to a DescribeLoadBasedAutoScaling request.

" }, "DescribeMyUserProfileResult":{ "type":"structure", "members":{ "UserProfile":{ "shape":"SelfUserProfile", "documentation":"

A UserProfile object that describes the user's SSH information.

" } }, "documentation":"

Contains the response to a DescribeMyUserProfile request.

" }, "DescribePermissionsRequest":{ "type":"structure", "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN. For more information about IAM ARNs, see Using Identifiers.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "DescribePermissionsResult":{ "type":"structure", "members":{ "Permissions":{ "shape":"Permissions", "documentation":"

An array of Permission objects that describe the stack permissions.

" } }, "documentation":"

Contains the response to a DescribePermissions request.

" }, "DescribeRaidArraysRequest":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "RaidArrayIds":{ "shape":"Strings", "documentation":"

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.

" } } }, "DescribeRaidArraysResult":{ "type":"structure", "members":{ "RaidArrays":{ "shape":"RaidArrays", "documentation":"

A RaidArrays object that describes the specified RAID arrays.

" } }, "documentation":"

Contains the response to a DescribeRaidArrays request.

" }, "DescribeRdsDbInstancesRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.

" }, "RdsDbInstanceArns":{ "shape":"Strings", "documentation":"

An array containing the ARNs of the instances to be described.

" } } }, "DescribeRdsDbInstancesResult":{ "type":"structure", "members":{ "RdsDbInstances":{ "shape":"RdsDbInstances", "documentation":"

An a array of RdsDbInstance objects that describe the instances.

" } }, "documentation":"

Contains the response to a DescribeRdsDbInstances request.

" }, "DescribeServiceErrorsRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.

" }, "ServiceErrorIds":{ "shape":"Strings", "documentation":"

An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.

" } } }, "DescribeServiceErrorsResult":{ "type":"structure", "members":{ "ServiceErrors":{ "shape":"ServiceErrors", "documentation":"

An array of ServiceError objects that describe the specified service errors.

" } }, "documentation":"

Contains the response to a DescribeServiceErrors request.

" }, "DescribeStackProvisioningParametersRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID

" } } }, "DescribeStackProvisioningParametersResult":{ "type":"structure", "members":{ "AgentInstallerUrl":{ "shape":"String", "documentation":"

The AWS OpsWorks agent installer's URL.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

An embedded object that contains the provisioning parameters.

" } }, "documentation":"

Contains the response to a DescribeStackProvisioningParameters request.

" }, "DescribeStackSummaryRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "DescribeStackSummaryResult":{ "type":"structure", "members":{ "StackSummary":{ "shape":"StackSummary", "documentation":"

A StackSummary object that contains the results.

" } }, "documentation":"

Contains the response to a DescribeStackSummary request.

" }, "DescribeStacksRequest":{ "type":"structure", "members":{ "StackIds":{ "shape":"Strings", "documentation":"

An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

" } } }, "DescribeStacksResult":{ "type":"structure", "members":{ "Stacks":{ "shape":"Stacks", "documentation":"

An array of Stack objects that describe the stacks.

" } }, "documentation":"

Contains the response to a DescribeStacks request.

" }, "DescribeTimeBasedAutoScalingRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"Strings", "documentation":"

An array of instance IDs.

" } } }, "DescribeTimeBasedAutoScalingResult":{ "type":"structure", "members":{ "TimeBasedAutoScalingConfigurations":{ "shape":"TimeBasedAutoScalingConfigurations", "documentation":"

An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.

" } }, "documentation":"

Contains the response to a DescribeTimeBasedAutoScaling request.

" }, "DescribeUserProfilesRequest":{ "type":"structure", "members":{ "IamUserArns":{ "shape":"Strings", "documentation":"

An array of IAM user ARNs that identify the users to be described.

" } } }, "DescribeUserProfilesResult":{ "type":"structure", "members":{ "UserProfiles":{ "shape":"UserProfiles", "documentation":"

A Users object that describes the specified users.

" } }, "documentation":"

Contains the response to a DescribeUserProfiles request.

" }, "DescribeVolumesRequest":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

" }, "StackId":{ "shape":"String", "documentation":"

A stack ID. The action describes the stack's registered Amazon EBS volumes.

" }, "RaidArrayId":{ "shape":"String", "documentation":"

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

" }, "VolumeIds":{ "shape":"Strings", "documentation":"

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

" } } }, "DescribeVolumesResult":{ "type":"structure", "members":{ "Volumes":{ "shape":"Volumes", "documentation":"

An array of volume IDs.

" } }, "documentation":"

Contains the response to a DescribeVolumes request.

" }, "DetachElasticLoadBalancerRequest":{ "type":"structure", "required":[ "ElasticLoadBalancerName", "LayerId" ], "members":{ "ElasticLoadBalancerName":{ "shape":"String", "documentation":"

The Elastic Load Balancing instance's name.

" }, "LayerId":{ "shape":"String", "documentation":"

The ID of the layer that the Elastic Load Balancing instance is attached to.

" } } }, "DisassociateElasticIpRequest":{ "type":"structure", "required":["ElasticIp"], "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP address.

" } } }, "Double":{ "type":"double", "box":true }, "ElasticIp":{ "type":"structure", "members":{ "Ip":{ "shape":"String", "documentation":"

The IP address.

" }, "Name":{ "shape":"String", "documentation":"

The name.

" }, "Domain":{ "shape":"String", "documentation":"

The domain.

" }, "Region":{ "shape":"String", "documentation":"

The AWS region. For more information, see Regions and Endpoints.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance that the address is attached to.

" } }, "documentation":"

Describes an Elastic IP address.

" }, "ElasticIps":{ "type":"list", "member":{"shape":"ElasticIp"} }, "ElasticLoadBalancer":{ "type":"structure", "members":{ "ElasticLoadBalancerName":{ "shape":"String", "documentation":"

The Elastic Load Balancing instance's name.

" }, "Region":{ "shape":"String", "documentation":"

The instance's AWS region.

" }, "DnsName":{ "shape":"String", "documentation":"

The instance's public DNS name.

" }, "StackId":{ "shape":"String", "documentation":"

The ID of the stack that the instance is associated with.

" }, "LayerId":{ "shape":"String", "documentation":"

The ID of the layer that the instance is attached to.

" }, "VpcId":{ "shape":"String", "documentation":"

The VPC ID.

" }, "AvailabilityZones":{ "shape":"Strings", "documentation":"

A list of Availability Zones.

" }, "SubnetIds":{ "shape":"Strings", "documentation":"

A list of subnet IDs, if the stack is running in a VPC.

" }, "Ec2InstanceIds":{ "shape":"Strings", "documentation":"

A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

" } }, "documentation":"

Describes an Elastic Load Balancing instance.

" }, "ElasticLoadBalancers":{ "type":"list", "member":{"shape":"ElasticLoadBalancer"} }, "EnvironmentVariable":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"String", "documentation":"

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

" }, "Value":{ "shape":"String", "documentation":"

(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.

" }, "Secure":{ "shape":"Boolean", "documentation":"

(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set Secure to true. DescribeApps then returns **Filtered** instead of the actual value. The default value for Secure is false.

" } }, "documentation":"

Represents an app's environment variable.

" }, "EnvironmentVariables":{ "type":"list", "member":{"shape":"EnvironmentVariable"} }, "GetHostnameSuggestionRequest":{ "type":"structure", "required":["LayerId"], "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" } } }, "GetHostnameSuggestionResult":{ "type":"structure", "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" }, "Hostname":{ "shape":"String", "documentation":"

The generated host name.

" } }, "documentation":"

Contains the response to a GetHostnameSuggestion request.

" }, "Hour":{"type":"string"}, "Instance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "Ec2InstanceId":{ "shape":"String", "documentation":"

The ID of the associated Amazon EC2 instance.

" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The instance's virtualization type, paravirtual or hvm.

" }, "Hostname":{ "shape":"String", "documentation":"

The instance host name.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

An array containing the instance layer IDs.

" }, "SecurityGroupIds":{ "shape":"Strings", "documentation":"

An array containing the instance security group IDs.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that specify the various types are in the API Name column of the Available Instance Types table.

" }, "InstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.

" }, "Status":{ "shape":"String", "documentation":"

The instance status:

" }, "Os":{ "shape":"String", "documentation":"

The instance's operating system.

" }, "AmiId":{ "shape":"String", "documentation":"

A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The instance Availability Zone. For more information, see Regions and Endpoints.

" }, "SubnetId":{ "shape":"String", "documentation":"

The instance's subnet ID, if the stack is running in a VPC.

" }, "PublicDns":{ "shape":"String", "documentation":"

The instance public DNS name.

" }, "PrivateDns":{ "shape":"String", "documentation":"

The instance private DNS name.

" }, "PublicIp":{ "shape":"String", "documentation":"

The instance public IP address.

" }, "PrivateIp":{ "shape":"String", "documentation":"

The instance private IP address.

" }, "ElasticIp":{ "shape":"String", "documentation":"

The instance Elastic IP address .

" }, "AutoScalingType":{ "shape":"AutoScalingType", "documentation":"

For load-based or time-based instances, the type.

" }, "SshKeyName":{ "shape":"String", "documentation":"

The instance SSH key name.

" }, "SshHostRsaKeyFingerprint":{ "shape":"String", "documentation":"

The SSH key's RSA fingerprint.

" }, "SshHostDsaKeyFingerprint":{ "shape":"String", "documentation":"

The SSH key's DSA fingerprint.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

The time that the instance was created.

" }, "LastServiceErrorId":{ "shape":"String", "documentation":"

The ID of the last service error. For more information, call DescribeServiceErrors.

" }, "Architecture":{ "shape":"Architecture", "documentation":"

The instance architecture, \"i386\" or \"x86_64\".

" }, "RootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The instance root device type. For more information, see Storage for the Root Device.

" }, "RootDeviceVolumeId":{ "shape":"String", "documentation":"

The root device volume ID.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Whether this is an Amazon EBS-optimized instance.

" }, "ReportedOs":{ "shape":"ReportedOs", "documentation":"

For registered instances, the reported operating system.

" }, "InfrastructureClass":{ "shape":"String", "documentation":"

For registered instances, the infrastructure class: ec2 or on-premises

" }, "RegisteredBy":{ "shape":"String", "documentation":"

For registered instances, who performed the registration.

" } }, "documentation":"

Describes an instance.

" }, "InstanceIdentity":{ "type":"structure", "members":{ "Document":{ "shape":"String", "documentation":"

A JSON document that contains the metadata.

" }, "Signature":{ "shape":"String", "documentation":"

A signature that can be used to verify the document's accuracy and authenticity.

" } }, "documentation":"

Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data.

" }, "Instances":{ "type":"list", "member":{"shape":"Instance"} }, "InstancesCount":{ "type":"structure", "members":{ "Assigning":{ "shape":"Integer", "documentation":"

The number of instances in the Assigning state.

" }, "Booting":{ "shape":"Integer", "documentation":"

The number of instances with booting status.

" }, "ConnectionLost":{ "shape":"Integer", "documentation":"

The number of instances with connection_lost status.

" }, "Deregistering":{ "shape":"Integer", "documentation":"

The number of instances in the Deregistering state.

" }, "Online":{ "shape":"Integer", "documentation":"

The number of instances with online status.

" }, "Pending":{ "shape":"Integer", "documentation":"

The number of instances with pending status.

" }, "Rebooting":{ "shape":"Integer", "documentation":"

The number of instances with rebooting status.

" }, "Registered":{ "shape":"Integer", "documentation":"

The number of instances in the Registered state.

" }, "Registering":{ "shape":"Integer", "documentation":"

The number of instances in the Registering state.

" }, "Requested":{ "shape":"Integer", "documentation":"

The number of instances with requested status.

" }, "RunningSetup":{ "shape":"Integer", "documentation":"

The number of instances with running_setup status.

" }, "SetupFailed":{ "shape":"Integer", "documentation":"

The number of instances with setup_failed status.

" }, "ShuttingDown":{ "shape":"Integer", "documentation":"

The number of instances with shutting_down status.

" }, "StartFailed":{ "shape":"Integer", "documentation":"

The number of instances with start_failed status.

" }, "Stopped":{ "shape":"Integer", "documentation":"

The number of instances with stopped status.

" }, "Stopping":{ "shape":"Integer", "documentation":"

The number of instances with stopping status.

" }, "Terminated":{ "shape":"Integer", "documentation":"

The number of instances with terminated status.

" }, "Terminating":{ "shape":"Integer", "documentation":"

The number of instances with terminating status.

" }, "Unassigning":{ "shape":"Integer", "documentation":"

The number of instances in the Unassigning state.

" } }, "documentation":"

Describes how many instances a stack has for each status.

" }, "Integer":{ "type":"integer", "box":true }, "Layer":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The layer stack ID.

" }, "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" }, "Type":{ "shape":"LayerType", "documentation":"

The layer type.

" }, "Name":{ "shape":"String", "documentation":"

The layer name.

" }, "Shortname":{ "shape":"String", "documentation":"

The layer short name.

" }, "Attributes":{ "shape":"LayerAttributes", "documentation":"

The layer attributes.

" }, "CustomInstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" }, "CustomSecurityGroupIds":{ "shape":"Strings", "documentation":"

An array containing the layer's custom security group IDs.

" }, "DefaultSecurityGroupNames":{ "shape":"Strings", "documentation":"

An array containing the layer's security group names.

" }, "Packages":{ "shape":"Strings", "documentation":"

An array of Package objects that describe the layer's packages.

" }, "VolumeConfigurations":{ "shape":"VolumeConfigurations", "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" }, "EnableAutoHealing":{ "shape":"Boolean", "documentation":"

Whether auto healing is disabled for the layer.

" }, "AutoAssignElasticIps":{ "shape":"Boolean", "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "AutoAssignPublicIps":{ "shape":"Boolean", "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "DefaultRecipes":{"shape":"Recipes"}, "CustomRecipes":{ "shape":"Recipes", "documentation":"

A LayerCustomRecipes object that specifies the layer's custom recipes.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

Date when the layer was created.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" }, "UseEbsOptimizedInstances":{ "shape":"Boolean", "documentation":"

Whether the layer uses Amazon EBS-optimized instances.

" }, "LifecycleEventConfiguration":{ "shape":"LifecycleEventConfiguration", "documentation":"

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

" } }, "documentation":"

Describes a layer.

" }, "LayerAttributes":{ "type":"map", "key":{"shape":"LayerAttributesKeys"}, "value":{"shape":"String"} }, "LayerAttributesKeys":{ "type":"string", "enum":[ "EnableHaproxyStats", "HaproxyStatsUrl", "HaproxyStatsUser", "HaproxyStatsPassword", "HaproxyHealthCheckUrl", "HaproxyHealthCheckMethod", "MysqlRootPassword", "MysqlRootPasswordUbiquitous", "GangliaUrl", "GangliaUser", "GangliaPassword", "MemcachedMemory", "NodejsVersion", "RubyVersion", "RubygemsVersion", "ManageBundler", "BundlerVersion", "RailsStack", "PassengerVersion", "Jvm", "JvmVersion", "JvmOptions", "JavaAppServer", "JavaAppServerVersion" ] }, "LayerType":{ "type":"string", "enum":[ "java-app", "lb", "web", "php-app", "rails-app", "nodejs-app", "memcached", "db-master", "monitoring-master", "custom" ] }, "Layers":{ "type":"list", "member":{"shape":"Layer"} }, "LifecycleEventConfiguration":{ "type":"structure", "members":{ "Shutdown":{ "shape":"ShutdownEventConfiguration", "documentation":"

A ShutdownEventConfiguration object that specifies the Shutdown event configuration.

" } }, "documentation":"

Specifies the lifecycle event configuration

" }, "LoadBasedAutoScalingConfiguration":{ "type":"structure", "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" }, "Enable":{ "shape":"Boolean", "documentation":"

Whether load-based auto scaling is enabled for the layer.

" }, "UpScaling":{ "shape":"AutoScalingThresholds", "documentation":"

An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when AWS OpsWorks increases the number of instances.

" }, "DownScaling":{ "shape":"AutoScalingThresholds", "documentation":"

An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when AWS OpsWorks reduces the number of instances.

" } }, "documentation":"

Describes a layer's load-based auto scaling configuration.

" }, "LoadBasedAutoScalingConfigurations":{ "type":"list", "member":{"shape":"LoadBasedAutoScalingConfiguration"} }, "Minute":{ "type":"integer", "min":1, "max":100, "box":true }, "Parameters":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Permission":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

A stack ID.

" }, "IamUserArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.

" }, "AllowSsh":{ "shape":"Boolean", "documentation":"

Whether the user can use SSH.

" }, "AllowSudo":{ "shape":"Boolean", "documentation":"

Whether the user can use sudo.

" }, "Level":{ "shape":"String", "documentation":"

The user's permission level, which must be the following:

For more information on the permissions associated with these levels, see Managing User Permissions

" } }, "documentation":"

Describes stack or user permissions.

" }, "Permissions":{ "type":"list", "member":{"shape":"Permission"} }, "RaidArray":{ "type":"structure", "members":{ "RaidArrayId":{ "shape":"String", "documentation":"

The array ID.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "Name":{ "shape":"String", "documentation":"

The array name.

" }, "RaidLevel":{ "shape":"Integer", "documentation":"

The RAID level.

" }, "NumberOfDisks":{ "shape":"Integer", "documentation":"

The number of disks in the array.

" }, "Size":{ "shape":"Integer", "documentation":"

The array's size.

" }, "Device":{ "shape":"String", "documentation":"

The array's Linux device. For example /dev/mdadm0.

" }, "MountPoint":{ "shape":"String", "documentation":"

The array's mount point.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The array's Availability Zone. For more information, see Regions and Endpoints.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

When the RAID array was created.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "VolumeType":{ "shape":"String", "documentation":"

The volume type, standard or PIOPS.

" }, "Iops":{ "shape":"Integer", "documentation":"

For PIOPS volumes, the IOPS per disk.

" } }, "documentation":"

Describes an instance's RAID array.

" }, "RaidArrays":{ "type":"list", "member":{"shape":"RaidArray"} }, "RdsDbInstance":{ "type":"structure", "members":{ "RdsDbInstanceArn":{ "shape":"String", "documentation":"

The instance's ARN.

" }, "DbInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier.

" }, "DbUser":{ "shape":"String", "documentation":"

The master user name.

" }, "DbPassword":{ "shape":"String", "documentation":"

The database password.

" }, "Region":{ "shape":"String", "documentation":"

The instance's AWS region.

" }, "Address":{ "shape":"String", "documentation":"

The instance's address.

" }, "Engine":{ "shape":"String", "documentation":"

The instance's database engine.

" }, "StackId":{ "shape":"String", "documentation":"

The ID of the stack that the instance is registered with.

" }, "MissingOnRds":{ "shape":"Boolean", "documentation":"

Set to true if AWS OpsWorks was unable to discover the Amazon RDS instance. AWS OpsWorks attempts to discover the instance only once. If this value is set to true, you must deregister the instance and then register it again.

" } }, "documentation":"

Describes an Amazon RDS instance.

" }, "RdsDbInstances":{ "type":"list", "member":{"shape":"RdsDbInstance"} }, "RebootInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "Recipes":{ "type":"structure", "members":{ "Setup":{ "shape":"Strings", "documentation":"

An array of custom recipe names to be run following a setup event.

" }, "Configure":{ "shape":"Strings", "documentation":"

An array of custom recipe names to be run following a configure event.

" }, "Deploy":{ "shape":"Strings", "documentation":"

An array of custom recipe names to be run following a deploy event.

" }, "Undeploy":{ "shape":"Strings", "documentation":"

An array of custom recipe names to be run following a undeploy event.

" }, "Shutdown":{ "shape":"Strings", "documentation":"

An array of custom recipe names to be run following a shutdown event.

" } }, "documentation":"

AWS OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

" }, "RegisterElasticIpRequest":{ "type":"structure", "required":[ "ElasticIp", "StackId" ], "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP address.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "RegisterElasticIpResult":{ "type":"structure", "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP address.

" } }, "documentation":"

Contains the response to a RegisterElasticIp request.

" }, "RegisterInstanceRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The ID of the stack that the instance is to be registered with.

" }, "Hostname":{ "shape":"String", "documentation":"

The instance's hostname.

" }, "PublicIp":{ "shape":"String", "documentation":"

The instance's public IP address.

" }, "PrivateIp":{ "shape":"String", "documentation":"

The instance's private IP address.

" }, "RsaPublicKey":{ "shape":"String", "documentation":"

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

" }, "RsaPublicKeyFingerprint":{ "shape":"String", "documentation":"

The instances public RSA key fingerprint.

" }, "InstanceIdentity":{ "shape":"InstanceIdentity", "documentation":"

An InstanceIdentity object that contains the instance's identity.

" } } }, "RegisterInstanceResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The registered instance's AWS OpsWorks ID.

" } }, "documentation":"

Contains the response to a RegisterInstanceResult request.

" }, "RegisterRdsDbInstanceRequest":{ "type":"structure", "required":[ "StackId", "RdsDbInstanceArn", "DbUser", "DbPassword" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "RdsDbInstanceArn":{ "shape":"String", "documentation":"

The Amazon RDS instance's ARN.

" }, "DbUser":{ "shape":"String", "documentation":"

The database's master user name.

" }, "DbPassword":{ "shape":"String", "documentation":"

The database password.

" } } }, "RegisterVolumeRequest":{ "type":"structure", "required":["StackId"], "members":{ "Ec2VolumeId":{ "shape":"String", "documentation":"

The Amazon EBS volume ID.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "RegisterVolumeResult":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

" } }, "documentation":"

Contains the response to a RegisterVolume request.

" }, "ReportedOs":{ "type":"structure", "members":{ "Family":{ "shape":"String", "documentation":"

The operating system family.

" }, "Name":{ "shape":"String", "documentation":"

The operating system name.

" }, "Version":{ "shape":"String", "documentation":"

The operating system version.

" } }, "documentation":"

A registered instance's reported operating system.

" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The exception message.

" } }, "exception":true, "documentation":"

Indicates that a resource was not found.

" }, "RootDeviceType":{ "type":"string", "enum":[ "ebs", "instance-store" ] }, "SelfUserProfile":{ "type":"structure", "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN.

" }, "Name":{ "shape":"String", "documentation":"

The user's name.

" }, "SshUsername":{ "shape":"String", "documentation":"

The user's SSH user name.

" }, "SshPublicKey":{ "shape":"String", "documentation":"

The user's SSH public key.

" } }, "documentation":"

Describes a user's SSH information.

" }, "ServiceError":{ "type":"structure", "members":{ "ServiceErrorId":{ "shape":"String", "documentation":"

The error ID.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "Type":{ "shape":"String", "documentation":"

The error type.

" }, "Message":{ "shape":"String", "documentation":"

A message that describes the error.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

When the error occurred.

" } }, "documentation":"

Describes an AWS OpsWorks service error.

" }, "ServiceErrors":{ "type":"list", "member":{"shape":"ServiceError"} }, "SetLoadBasedAutoScalingRequest":{ "type":"structure", "required":["LayerId"], "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" }, "Enable":{ "shape":"Boolean", "documentation":"

Enables load-based auto scaling for the layer.

" }, "UpScaling":{ "shape":"AutoScalingThresholds", "documentation":"

An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks starts a specified number of instances.

" }, "DownScaling":{ "shape":"AutoScalingThresholds", "documentation":"

An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks stops a specified number of instances.

" } } }, "SetPermissionRequest":{ "type":"structure", "required":[ "StackId", "IamUserArn" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN.

" }, "AllowSsh":{ "shape":"Boolean", "documentation":"

The user is allowed to use SSH to communicate with the instance.

" }, "AllowSudo":{ "shape":"Boolean", "documentation":"

The user is allowed to use sudo to elevate privileges.

" }, "Level":{ "shape":"String", "documentation":"

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

For more information on the permissions associated with these levels, see Managing User Permissions

" } } }, "SetTimeBasedAutoScalingRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "AutoScalingSchedule":{ "shape":"WeeklyAutoScalingSchedule", "documentation":"

An AutoScalingSchedule with the instance schedule.

" } } }, "ShutdownEventConfiguration":{ "type":"structure", "members":{ "ExecutionTimeout":{ "shape":"Integer", "documentation":"

The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.

" }, "DelayUntilElbConnectionsDrained":{ "shape":"Boolean", "documentation":"

Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining

" } }, "documentation":"

The Shutdown event configuration.

" }, "Source":{ "type":"structure", "members":{ "Type":{ "shape":"SourceType", "documentation":"

The repository type.

" }, "Url":{ "shape":"String", "documentation":"

The source URL.

" }, "Username":{ "shape":"String", "documentation":"

This parameter depends on the repository type.

" }, "Password":{ "shape":"String", "documentation":"

This parameter depends on the repository type.

For more information on how to safely handle IAM credentials, see .

" }, "SshKey":{ "shape":"String", "documentation":"

The repository's SSH key.

" }, "Revision":{ "shape":"String", "documentation":"

The application's version. AWS OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

" } }, "documentation":"

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

" }, "SourceType":{ "type":"string", "enum":[ "git", "svn", "archive", "s3" ] }, "SslConfiguration":{ "type":"structure", "required":[ "Certificate", "PrivateKey" ], "members":{ "Certificate":{ "shape":"String", "documentation":"

The contents of the certificate's domain.crt file.

" }, "PrivateKey":{ "shape":"String", "documentation":"

The private key; the contents of the certificate's domain.kex file.

" }, "Chain":{ "shape":"String", "documentation":"

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

" } }, "documentation":"

Describes an app's SSL configuration.

" }, "Stack":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "Name":{ "shape":"String", "documentation":"

The stack name.

" }, "Arn":{ "shape":"String", "documentation":"

The stack's ARN.

" }, "Region":{ "shape":"String", "documentation":"

The stack AWS region, such as \"us-east-1\". For more information about AWS regions, see Regions and Endpoints.

" }, "VpcId":{ "shape":"String", "documentation":"

The VPC ID, if the stack is running in a VPC.

" }, "Attributes":{ "shape":"StackAttributes", "documentation":"

The stack's attributes.

" }, "ServiceRoleArn":{ "shape":"String", "documentation":"

The stack AWS Identity and Access Management (IAM) role.

" }, "DefaultInstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" }, "DefaultOs":{ "shape":"String", "documentation":"

The stack's default operating system.

" }, "HostnameTheme":{ "shape":"String", "documentation":"

The stack host name theme, with spaces replaced by underscores.

" }, "DefaultAvailabilityZone":{ "shape":"String", "documentation":"

The stack's default Availability Zone. For more information, see Regions and Endpoints.

" }, "DefaultSubnetId":{ "shape":"String", "documentation":"

The default subnet ID, if the stack is running in a VPC.

" }, "CustomJson":{ "shape":"String", "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

" }, "ConfigurationManager":{ "shape":"StackConfigurationManager", "documentation":"

The configuration manager.

" }, "ChefConfiguration":{ "shape":"ChefConfiguration", "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

" }, "UseCustomCookbooks":{ "shape":"Boolean", "documentation":"

Whether the stack uses custom cookbooks.

" }, "UseOpsworksSecurityGroups":{ "shape":"Boolean", "documentation":"

Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.

" }, "CustomCookbooksSource":{"shape":"Source"}, "DefaultSshKeyName":{ "shape":"String", "documentation":"

A default SSH key for the stack's instances. You can override this value when you create or update an instance.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

Date when the stack was created.

" }, "DefaultRootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" } }, "documentation":"

Describes a stack.

" }, "StackAttributes":{ "type":"map", "key":{"shape":"StackAttributesKeys"}, "value":{"shape":"String"} }, "StackAttributesKeys":{ "type":"string", "enum":["Color"] }, "StackConfigurationManager":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name. This parameter must be set to \"Chef\".

" }, "Version":{ "shape":"String", "documentation":"

The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.

" } }, "documentation":"

Describes the configuration manager.

" }, "StackSummary":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "Name":{ "shape":"String", "documentation":"

The stack name.

" }, "Arn":{ "shape":"String", "documentation":"

The stack's ARN.

" }, "LayersCount":{ "shape":"Integer", "documentation":"

The number of layers.

" }, "AppsCount":{ "shape":"Integer", "documentation":"

The number of apps.

" }, "InstancesCount":{ "shape":"InstancesCount", "documentation":"

An InstancesCount object with the number of instances in each status.

" } }, "documentation":"

Summarizes the number of layers, instances, and apps in a stack.

" }, "Stacks":{ "type":"list", "member":{"shape":"Stack"} }, "StartInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "StartStackRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "StopInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "StopStackRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "String":{"type":"string"}, "Strings":{ "type":"list", "member":{"shape":"String"} }, "Switch":{"type":"string"}, "TimeBasedAutoScalingConfiguration":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "AutoScalingSchedule":{ "shape":"WeeklyAutoScalingSchedule", "documentation":"

A WeeklyAutoScalingSchedule object with the instance schedule.

" } }, "documentation":"

Describes an instance's time-based auto scaling configuration.

" }, "TimeBasedAutoScalingConfigurations":{ "type":"list", "member":{"shape":"TimeBasedAutoScalingConfiguration"} }, "UnassignInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "UnassignVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

" } } }, "UpdateAppRequest":{ "type":"structure", "required":["AppId"], "members":{ "AppId":{ "shape":"String", "documentation":"

The app ID.

" }, "Name":{ "shape":"String", "documentation":"

The app name.

" }, "Description":{ "shape":"String", "documentation":"

A description of the app.

" }, "DataSources":{ "shape":"DataSources", "documentation":"

The app's data sources.

" }, "Type":{ "shape":"AppType", "documentation":"

The app type.

" }, "AppSource":{ "shape":"Source", "documentation":"

A Source object that specifies the app repository.

" }, "Domains":{ "shape":"Strings", "documentation":"

The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

" }, "EnableSsl":{ "shape":"Boolean", "documentation":"

Whether SSL is enabled for the app.

" }, "SslConfiguration":{ "shape":"SslConfiguration", "documentation":"

An SslConfiguration object with the SSL configuration.

" }, "Attributes":{ "shape":"AppAttributes", "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" }, "Environment":{ "shape":"EnvironmentVariables", "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. You can specify up to ten environment variables. After you deploy the app, these variables are defined on the associated app server instances.

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version." } } }, "UpdateElasticIpRequest":{ "type":"structure", "required":["ElasticIp"], "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The address.

" }, "Name":{ "shape":"String", "documentation":"

The new name.

" } } }, "UpdateInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

The instance's layer IDs.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

" }, "AutoScalingType":{ "shape":"AutoScalingType", "documentation":"

For load-based or time-based instances, the type.

" }, "Hostname":{ "shape":"String", "documentation":"

The instance host name.

" }, "Os":{ "shape":"String", "documentation":"

The instance's operating system, which must be set to one of the following.

The default option is the current Amazon Linux version, such as Amazon Linux 2014.09. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

" }, "AmiId":{ "shape":"String", "documentation":"

A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks AMIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances

If you specify a custom AMI, you must set Os to Custom." }, "SshKeyName":{ "shape":"String", "documentation":"

The instance SSH key name.

" }, "Architecture":{ "shape":"Architecture", "documentation":"

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Whether this is an Amazon EBS-optimized instance.

" } } }, "UpdateLayerRequest":{ "type":"structure", "required":["LayerId"], "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" }, "Name":{ "shape":"String", "documentation":"

The layer name, which is used by the console.

" }, "Shortname":{ "shape":"String", "documentation":"

The layer short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.

" }, "Attributes":{ "shape":"LayerAttributes", "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" }, "CustomInstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" }, "CustomSecurityGroupIds":{ "shape":"Strings", "documentation":"

An array containing the layer's custom security group IDs.

" }, "Packages":{ "shape":"Strings", "documentation":"

An array of Package objects that describe the layer's packages.

" }, "VolumeConfigurations":{ "shape":"VolumeConfigurations", "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" }, "EnableAutoHealing":{ "shape":"Boolean", "documentation":"

Whether to disable auto healing for the layer.

" }, "AutoAssignElasticIps":{ "shape":"Boolean", "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "AutoAssignPublicIps":{ "shape":"Boolean", "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "CustomRecipes":{ "shape":"Recipes", "documentation":"

A LayerCustomRecipes object that specifies the layer's custom recipes.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" }, "UseEbsOptimizedInstances":{ "shape":"Boolean", "documentation":"

Whether to use Amazon EBS-optimized instances.

" }, "LifecycleEventConfiguration":{ "shape":"LifecycleEventConfiguration", "documentation":"

" } } }, "UpdateMyUserProfileRequest":{ "type":"structure", "members":{ "SshPublicKey":{ "shape":"String", "documentation":"

The user's SSH public key.

" } } }, "UpdateRdsDbInstanceRequest":{ "type":"structure", "required":["RdsDbInstanceArn"], "members":{ "RdsDbInstanceArn":{ "shape":"String", "documentation":"

The Amazon RDS instance's ARN.

" }, "DbUser":{ "shape":"String", "documentation":"

The master user name.

" }, "DbPassword":{ "shape":"String", "documentation":"

The database password.

" } } }, "UpdateStackRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "Name":{ "shape":"String", "documentation":"

The stack's new name.

" }, "Attributes":{ "shape":"StackAttributes", "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" }, "ServiceRoleArn":{ "shape":"String", "documentation":"

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the stack's current service role ARN, if you prefer, but you must do so explicitly.

" }, "DefaultInstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" }, "DefaultOs":{ "shape":"String", "documentation":"

The stack's operating system, which must be set to one of the following.

The default option is the current Amazon Linux version.

" }, "HostnameTheme":{ "shape":"String", "documentation":"

The stack's new host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" }, "DefaultAvailabilityZone":{ "shape":"String", "documentation":"

The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

" }, "DefaultSubnetId":{ "shape":"String", "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" }, "CustomJson":{ "shape":"String", "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

" }, "ConfigurationManager":{ "shape":"StackConfigurationManager", "documentation":"

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.

" }, "ChefConfiguration":{ "shape":"ChefConfiguration", "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" }, "UseCustomCookbooks":{ "shape":"Boolean", "documentation":"

Whether the stack uses custom cookbooks.

" }, "CustomCookbooksSource":{"shape":"Source"}, "DefaultSshKeyName":{ "shape":"String", "documentation":"

A default SSH key for the stack instances. You can override this value when you create or update an instance.

" }, "DefaultRootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" }, "UseOpsworksSecurityGroups":{ "shape":"Boolean", "documentation":"

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

For more information, see Create a New Stack.

" } } }, "UpdateUserProfileRequest":{ "type":"structure", "required":["IamUserArn"], "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user IAM ARN.

" }, "SshUsername":{ "shape":"String", "documentation":"

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.

" }, "SshPublicKey":{ "shape":"String", "documentation":"

The user's new SSH public key.

" }, "AllowSelfManagement":{ "shape":"Boolean", "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

" } } }, "UpdateVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

" }, "Name":{ "shape":"String", "documentation":"

The new name.

" }, "MountPoint":{ "shape":"String", "documentation":"

The new mount point.

" } } }, "UserProfile":{ "type":"structure", "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN.

" }, "Name":{ "shape":"String", "documentation":"

The user's name.

" }, "SshUsername":{ "shape":"String", "documentation":"

The user's SSH user name.

" }, "SshPublicKey":{ "shape":"String", "documentation":"

The user's SSH public key.

" }, "AllowSelfManagement":{ "shape":"Boolean", "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

" } }, "documentation":"

Describes a user's SSH information.

" }, "UserProfiles":{ "type":"list", "member":{"shape":"UserProfile"} }, "ValidationException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The exception message.

" } }, "exception":true, "documentation":"

Indicates that a request was invalid.

" }, "VirtualizationType":{ "type":"string", "enum":[ "paravirtual", "hvm" ] }, "Volume":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

" }, "Ec2VolumeId":{ "shape":"String", "documentation":"

The Amazon EC2 volume ID.

" }, "Name":{ "shape":"String", "documentation":"

The volume name.

" }, "RaidArrayId":{ "shape":"String", "documentation":"

The RAID array ID.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "Status":{ "shape":"String", "documentation":"

The value returned by DescribeVolumes.

" }, "Size":{ "shape":"Integer", "documentation":"

The volume size.

" }, "Device":{ "shape":"String", "documentation":"

The device name.

" }, "MountPoint":{ "shape":"String", "documentation":"

The volume mount point. For example \"/dev/sdh\".

" }, "Region":{ "shape":"String", "documentation":"

The AWS region. For more information about AWS regions, see Regions and Endpoints.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The volume Availability Zone. For more information, see Regions and Endpoints.

" }, "VolumeType":{ "shape":"String", "documentation":"

The volume type, standard or PIOPS.

" }, "Iops":{ "shape":"Integer", "documentation":"

For PIOPS volumes, the IOPS per disk.

" } }, "documentation":"

Describes an instance's Amazon EBS volume.

" }, "VolumeConfiguration":{ "type":"structure", "required":[ "MountPoint", "NumberOfDisks", "Size" ], "members":{ "MountPoint":{ "shape":"String", "documentation":"

The volume mount point. For example \"/dev/sdh\".

" }, "RaidLevel":{ "shape":"Integer", "documentation":"

The volume RAID level.

" }, "NumberOfDisks":{ "shape":"Integer", "documentation":"

The number of disks in the volume.

" }, "Size":{ "shape":"Integer", "documentation":"

The volume size.

" }, "VolumeType":{ "shape":"String", "documentation":"

The volume type:

" }, "Iops":{ "shape":"Integer", "documentation":"

For PIOPS volumes, the IOPS per disk.

" } }, "documentation":"

Describes an Amazon EBS volume configuration.

" }, "VolumeConfigurations":{ "type":"list", "member":{"shape":"VolumeConfiguration"} }, "Volumes":{ "type":"list", "member":{"shape":"Volume"} }, "WeeklyAutoScalingSchedule":{ "type":"structure", "members":{ "Monday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Monday.

" }, "Tuesday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Tuesday.

" }, "Wednesday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Wednesday.

" }, "Thursday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Thursday.

" }, "Friday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Friday.

" }, "Saturday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Saturday.

" }, "Sunday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Sunday.

" } }, "documentation":"

Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.

The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.

The following example specifies that the instance should be online for four hours, from UTC 1200 - 1600. It will be off for the remainder of the day.

{ \"12\":\"on\", \"13\":\"on\", \"14\":\"on\", \"15\":\"on\" }

" } } }