Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks\n actions and data types, including common parameters and error codes.
\nAWS OpsWorks is an application management service that provides an integrated experience for overseeing the\n complete application lifecycle. For information about this product, go to the\n AWS OpsWorks details page.
\n\nSDKs and CLI
\nThe most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or\n by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
\nEndpoints
\nAWS 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\n to direct AWS OpsWorks to create stacks in any AWS Region.
\nChef Version
\nWhen you call CreateStack, CloneStack, or UpdateStack we recommend you use\n the ConfigurationManager parameter to specify the Chef version, 0.9 or 11.4.\n The default value is currently 0.9. However, we expect to change the default value to 11.4 in October 2013. \n For more information, see Using AWS OpsWorks with Chef 11.
The volume ID.
\n ", "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nAssigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered\n with the stack by calling RegisterVolume. For more information, see\n Resource Management.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "AssociateElasticIp": { "name": "AssociateElasticIp", "input": { "shape_name": "AssociateElasticIpRequest", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\nThe Elastic IP address.
\n ", "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nAssociates one of the stack's registered Elastic IP addresses with a specified instance. The address\n must first be registered with the stack by calling RegisterElasticIp. For more information, see\n Resource Management.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "AttachElasticLoadBalancer": { "name": "AttachElasticLoadBalancer", "input": { "shape_name": "AttachElasticLoadBalancerRequest", "type": "structure", "members": { "ElasticLoadBalancerName": { "shape_name": "String", "type": "string", "documentation": "\nThe Elastic Load Balancing instance's name.
\n ", "required": true }, "LayerId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the layer that the Elastic Load Balancing instance is to be attached to.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nAttaches an Elastic Load Balancing load balancer to a specified layer.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "CloneStack": { "name": "CloneStack", "input": { "shape_name": "CloneStackRequest", "type": "structure", "members": { "SourceStackId": { "shape_name": "String", "type": "string", "documentation": "\nThe source stack ID.
\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe cloned stack name.
\n " }, "Region": { "shape_name": "String", "type": "string", "documentation": "\nThe cloned stack AWS region, such as \"us-east-1\". For more information about AWS regions, see\n Regions and Endpoints.
\n ", "cli_name": "stack-region" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the VPC that the cloned stack is to be launched into. It must be in the specified region.\n All instances will be launched into this VPC, and you cannot change the ID later.
\nIf the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or \n the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter.\n If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified\n region and the corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
\nDefaultSubnetId.For more information on how to use AWS OpsWorks with a VPC, see\n Running a Stack in a VPC. For more information on\n default VPC and EC2 Classic, see Supported Platforms.\n
\n " }, "Attributes": { "shape_name": "StackAttributes", "type": "map", "keys": { "shape_name": "StackAttributesKeys", "type": "string", "enum": [ "Color" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nA list of stack attributes and values as key/value pairs to be added to the cloned stack.
\n " }, "ServiceRoleArn": { "shape_name": "String", "type": "string", "documentation": "\nThe stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf.\n 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,\n 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\n Using Identifiers.
\nThe 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\n Using Identifiers.
\n " }, "DefaultOs": { "shape_name": "String", "type": "string", "documentation": "\nThe cloned stack's default operating system, which must be set to Amazon Linux or Ubuntu 12.04 LTS.\n The default option is Amazon Linux.\n
The stack's host name theme, with spaces are replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:
Baked_GoodsCloudsEuropean_CitiesFruitsGreek_DeitiesLegendary_Creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_CatsTo obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The cloned stack's default Availability Zone, which must be in the specified region. For more information, see\n Regions and Endpoints.\n If you also specify a value for DefaultSubnetId, the subnet must be in the same zone.\n For more information, see the VpcId parameter description.\n
The stack's default subnet ID.\n All instances will be launched into this subnet unless you specify otherwise when you create the instance.\n If you also specify a value for DefaultAvailabilityZone, the subnet must be in the same zone.\n For information on default values and when this parameter is required, see the VpcId parameter description.\n
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON\n values. The string should be in the following format and must escape characters such as '\"'.:
\n\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON
\n " }, "ConfigurationManager": { "shape_name": "StackConfigurationManager", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name. This parameter must be set to \"Chef\".
\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\nThe Chef version. This parameter must be set to \"0.9\" or \"11.4\". The default value is \"0.9\".\n However, we expect to change the default value to \"11.4\" in September 2013.
\n " } }, "documentation": "\nThe configuration manager. When you clone a stack we recommend that you use the configuration manager to\n specify the Chef version, 0.9 or 11.4. The default value is currently 0.9.\n However, we expect to change the default value to 11.4 in September 2013.
\n " }, "UseCustomCookbooks": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether to use custom cookbooks.
\n " }, "CustomCookbooksSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\nThe repository type.
\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\nThe source URL.
" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\nThis parameter depends on the repository type.
\nUsername to the appropriate AWS access key.Username to the user name.This parameter depends on the repository type.
\nPassword to the appropriate AWS secret key.Password to the password.The repository's SSH key.
\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\nThe application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.
\n " } }, "documentation": "\nContains the information required to retrieve an app or cookbook from a repository. For more information, see\n Creating Apps or\n Custom Recipes and Cookbooks.
\n " }, "DefaultSshKeyName": { "shape_name": "String", "type": "string", "documentation": "\nA default SSH key for the stack instances. You can override this value when you create or update an instance.
\n " }, "ClonePermissions": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether to clone the source stack's permissions.
\n " }, "CloneAppIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nA list of source stack app IDs to be included in the cloned stack.
\n " }, "DefaultRootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\nThe default root device type. This value is used by default for all instances in the cloned stack,\n but you can override it when you create an instance. For more information, see\n Storage for the Root Device.
\n " } }, "documentation": null }, "output": { "shape_name": "CloneStackResult", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe cloned stack ID.
\n " } }, "documentation": "Contains the response to a CloneStack request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nCreates a clone of a specified stack. For more information, see\n Clone a Stack.
\nRequired Permissions: To use this action, an IAM user must have an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "CreateApp": { "name": "CreateApp", "input": { "shape_name": "CreateAppRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n ", "required": true }, "Shortname": { "shape_name": "String", "type": "string", "documentation": "\nThe app's short name.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe app name.
\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the app.
\n " }, "Type": { "shape_name": "AppType", "type": "string", "enum": [ "rails", "php", "nodejs", "static", "other" ], "documentation": "\nThe app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer.\n AWS OpsWorks deploys an application to those instances that are members of the corresponding layer.
\n ", "required": true }, "AppSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\nThe repository type.
\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\nThe source URL.
" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\nThis parameter depends on the repository type.
\nUsername to the appropriate AWS access key.Username to the user name.This parameter depends on the repository type.
\nPassword to the appropriate AWS secret key.Password to the password.The repository's SSH key.
\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\nThe application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.
\n " } }, "documentation": "\nA Source object that specifies the app repository.
The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
Whether to enable SSL for the app.
\n " }, "SslConfiguration": { "shape_name": "SslConfiguration", "type": "structure", "members": { "Certificate": { "shape_name": "String", "type": "string", "documentation": "\nThe contents of the certificate's domain.crt file.
\n ", "required": true }, "PrivateKey": { "shape_name": "String", "type": "string", "documentation": "\nThe private key; the contents of the certificate's domain.kex file.
\n ", "required": true }, "Chain": { "shape_name": "String", "type": "string", "documentation": "\nOptional. Can be used to specify an intermediate certificate authority key or client authentication.
\n " } }, "documentation": "\nAn SslConfiguration object with the SSL configuration.
One or more user-defined key/value pairs to be added to the stack attributes bag.
\n " } }, "documentation": null }, "output": { "shape_name": "CreateAppResult", "type": "structure", "members": { "AppId": { "shape_name": "String", "type": "string", "documentation": "\nThe app ID.
\n " } }, "documentation": "Contains the response to a CreateApp request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nCreates an app for a specified stack. For more information, see\n Creating Apps.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "CreateDeployment": { "name": "CreateDeployment", "input": { "shape_name": "CreateDeploymentRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n ", "required": true }, "AppId": { "shape_name": "String", "type": "string", "documentation": "\nThe app ID. This parameter is required for app deployments, but not for other deployment commands.
\n " }, "InstanceIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nThe instance IDs for the deployment targets.
\n " }, "Command": { "shape_name": "DeploymentCommand", "type": "structure", "members": { "Name": { "shape_name": "DeploymentCommandName", "type": "string", "enum": [ "install_dependencies", "update_dependencies", "update_custom_cookbooks", "execute_recipes", "deploy", "rollback", "start", "stop", "restart", "undeploy" ], "documentation": "\nSpecifies the deployment operation. You can specify only one command.
\nFor stacks, the available commands are:
\nexecute_recipes: Execute the recipes that are specified by the Args parameter.install_dependencies: Installs the stack's dependencies.update_custom_cookbooks: Update the stack's custom cookbooks.update_dependencies: Update the stack's dependencies.For apps, the available commands are:
\ndeploy: Deploy the app.rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks stores the previous version,\n up to a maximum of five versions. You can use this command to roll an app back as many as four versions.start: Start the app's web or application server.stop: Stop the app's web or application server.restart: Restart the app's web or application server.undeploy: Undeploy the app.An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes\n command.
A DeploymentCommand object that specifies the deployment command and any associated arguments.
A user-defined comment.
\n " }, "CustomJson": { "shape_name": "String", "type": "string", "documentation": "\nA string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. \nThe string should be in the following format and must escape characters such as '\"'.:
\n\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
\n " } }, "documentation": null }, "output": { "shape_name": "CreateDeploymentResult", "type": "structure", "members": { "DeploymentId": { "shape_name": "String", "type": "string", "documentation": "\nThe deployment ID, which can be used with other requests to identify the deployment.
\n " } }, "documentation": "Contains the response to a CreateDeployment request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDeploys a stack or app.
\ndeploy event, which runs the associated recipes and passes them a JSON stack configuration object\n that includes information about the app. deploy recipes but does not raise an event.For more information, see Deploying Apps\n and Run Stack Commands.
\nRequired Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "CreateInstance": { "name": "CreateInstance", "input": { "shape_name": "CreateInstanceRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n ", "required": true }, "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array that contains the instance layer IDs.
\n ", "required": true }, "InstanceType": { "shape_name": "String", "type": "string", "documentation": "\nThe instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster.\n For more information, see Instance Families and Types.\n The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
\n ", "required": true }, "AutoScalingType": { "shape_name": "AutoScalingType", "type": "string", "enum": [ "load", "timer" ], "documentation": "\nThe instance auto scaling type, which has three possible values:
\nThe instance host name.
\n " }, "Os": { "shape_name": "String", "type": "string", "documentation": "\nThe instance operating system, which must be set to one of the following.
\nAmazon Linux or Ubuntu 12.04 LTS\nCustom\nThe default option is Amazon Linux. If you set this parameter to Custom, you must use the\n CreateInstance action's AmiId parameter to specify\n the custom AMI that you want to use. For more information on the standard operating systems, see\n Operating SystemsFor more information\n on how to use custom AMIs with OpsWorks, see\n Using Custom AMIs.
A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs:\n Amazon Linux or Ubuntu 12.04 LTS. For more information, see\n Instances
" }, "SshKeyName": { "shape_name": "String", "type": "string", "documentation": "\nThe instance SSH key name.
\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe instance Availability Zone. For more information, see\n Regions and Endpoints.
\n " }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter\n to override the stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet.\n
\n " }, "Architecture": { "shape_name": "Architecture", "type": "string", "enum": [ "x86_64", "i386" ], "documentation": "\nThe instance architecture. Instance types do not necessarily support both architectures.\n For a list of the architectures that are supported by the different instance types, see\n Instance Families and Types.
\n " }, "RootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\nThe instance root device type. For more information, see \n Storage for the Root Device.
\n " }, "InstallUpdatesOnBoot": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether to install operating system and package updates when the instance boots. The default value is true.\n To control when updates are installed, set this value to false. You must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n
true, to ensure that your instances have the latest security updates.The instance ID.
\n " } }, "documentation": "Contains the response to a CreateInstance request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nCreates an instance in a specified stack. For more information, see\n Adding an Instance to a Layer.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "CreateLayer": { "name": "CreateLayer", "input": { "shape_name": "CreateLayerRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe layer stack ID.
\n ", "required": true }, "Type": { "shape_name": "LayerType", "type": "string", "enum": [ "lb", "web", "php-app", "rails-app", "nodejs-app", "memcached", "db-master", "monitoring-master", "custom" ], "documentation": "\nThe layer type. A stack cannot have more than one layer of the same type. This parameter must be set to one of the following:
\nThe layer name, which is used by the console.
\n ", "required": true }, "Shortname": { "shape_name": "String", "type": "string", "documentation": " \nThe 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\n directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric\n characters, '-', '_', and '.'.
\n ", "required": true }, "Attributes": { "shape_name": "LayerAttributes", "type": "map", "keys": { "shape_name": "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" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nOne or more user-defined key/value pairs to be added to the stack attributes bag.
\n " }, "CustomInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\nThe ARN of an IAM profile that to be used for the layer's EC2 instances. For more information about IAM ARNs, see\n Using Identifiers.
\n " }, "CustomSecurityGroupIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array containing the layer custom security group IDs.
\n " }, "Packages": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of Package objects that describe the layer packages.
The volume mount point. For example \"/dev/sdh\".
\n ", "required": true }, "RaidLevel": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe volume RAID level.
\n " }, "NumberOfDisks": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe number of disks in the volume.
\n ", "required": true }, "Size": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe volume size.
\n ", "required": true } }, "documentation": "\nDescribes an Amazon EBS volume configuration.
\n " }, "documentation": "\nA VolumeConfigurations object that describes the layer Amazon EBS volumes.
Whether to disable auto healing for the layer.
\n " }, "AutoAssignElasticIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether to automatically assign an Elastic\n IP address to the layer's instances.\n For more information, see How to Edit a Layer.
\n " }, "AutoAssignPublicIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nFor stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.\n For more information, see How to Edit a Layer.
\n " }, "CustomRecipes": { "shape_name": "Recipes", "type": "structure", "members": { "Setup": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of custom recipe names to be run following a setup event.
An array of custom recipe names to be run following a configure event.
An array of custom recipe names to be run following a deploy event.
An array of custom recipe names to be run following a undeploy event.
An array of custom recipe names to be run following a shutdown event.
A LayerCustomRecipes object that specifies the layer custom recipes.
Whether to install operating system and package updates when the instance boots. The default value is true.\n To control when updates are installed, set this value to false. You must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n
true, to ensure that your instances have the latest security updates.The layer ID.
\n " } }, "documentation": "Contains the response to a CreateLayer request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nCreates a layer. For more information, see\n How to Create a Layer.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "CreateStack": { "name": "CreateStack", "input": { "shape_name": "CreateStackRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe stack name.
\n ", "required": true }, "Region": { "shape_name": "String", "type": "string", "documentation": "\nThe stack AWS region, such as \"us-east-1\". For more information about Amazon regions, see\n Regions and Endpoints.
\n ", "required": true, "cli_name": "stack-region" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the VPC that the stack is to be launched into. It must be in the specified region.\n All instances will be launched into this VPC, and you cannot change the ID later.
\nIf the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or \n the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter.\n If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified\n region and the corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
\nDefaultSubnetId.For more information on how to use AWS OpsWorks with a VPC, see\n Running a Stack in a VPC. For more information on\n default VPC and EC2 Classic, see Supported Platforms.\n
\n " }, "Attributes": { "shape_name": "StackAttributes", "type": "map", "keys": { "shape_name": "StackAttributesKeys", "type": "string", "enum": [ "Color" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nOne or more user-defined key/value pairs to be added to the stack attributes bag.
\n " }, "ServiceRoleArn": { "shape_name": "String", "type": "string", "documentation": "\nThe stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf.\n You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see\n Using Identifiers.
\n ", "required": true }, "DefaultInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\nThe 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\n Using Identifiers.
\n ", "required": true }, "DefaultOs": { "shape_name": "String", "type": "string", "documentation": "\nThe stack's default operating system, which must be set to Amazon Linux or Ubuntu 12.04 LTS.\n The default option is Amazon Linux.\n
The stack's host name theme, with spaces are replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:
Baked_GoodsCloudsEuropean_CitiesFruitsGreek_DeitiesLegendary_Creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_CatsTo obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The stack's default Availability Zone, which must be in the specified region. For more information, see\n Regions and Endpoints.\n If you also specify a value for DefaultSubnetId, the subnet must be in the same zone.\n For more information, see the VpcId parameter description.\n
The stack's default subnet ID.\n All instances will be launched into this subnet unless you specify otherwise when you create the instance.\n If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone.\n For information on default values and when this parameter is required, see the VpcId parameter description.\n
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. \nThe string should be in the following format and must escape characters such as '\"'.:
\n\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
\n " }, "ConfigurationManager": { "shape_name": "StackConfigurationManager", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name. This parameter must be set to \"Chef\".
\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\nThe Chef version. This parameter must be set to \"0.9\" or \"11.4\". The default value is \"0.9\".\n However, we expect to change the default value to \"11.4\" in September 2013.
\n " } }, "documentation": "\nThe configuration manager. When you create a stack we recommend that you use the configuration manager to\n specify the Chef version, 0.9 or 11.4. The default value is currently 0.9.\n However, we expect to change the default value to 11.4 in September 2013.
\n " }, "UseCustomCookbooks": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether the stack uses custom cookbooks.
\n " }, "CustomCookbooksSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\nThe repository type.
\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\nThe source URL.
" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\nThis parameter depends on the repository type.
\nUsername to the appropriate AWS access key.Username to the user name.This parameter depends on the repository type.
\nPassword to the appropriate AWS secret key.Password to the password.The repository's SSH key.
\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\nThe application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.
\n " } }, "documentation": "\nContains the information required to retrieve an app or cookbook from a repository. For more information, see\n Creating Apps or\n Custom Recipes and Cookbooks.
\n " }, "DefaultSshKeyName": { "shape_name": "String", "type": "string", "documentation": "\nA default SSH key for the stack instances. You can override this value when you create or update an instance.
\n " }, "DefaultRootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\nThe default root device type. This value is used by default for all instances in the cloned stack,\n but you can override it when you create an instance. For more information, see \n Storage for the Root Device.
\n " } }, "documentation": null }, "output": { "shape_name": "CreateStackResult", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID, which is an opaque string that you use to identify the stack when performing actions\n such as DescribeStacks.
Contains the response to a CreateStack request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " } ], "documentation": "\nCreates a new stack. For more information, see\n Create a New Stack.
\nRequired Permissions: To use this action, an IAM user must have an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "CreateUserProfile": { "name": "CreateUserProfile", "input": { "shape_name": "CreateUserProfileRequest", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\nThe user's IAM ARN.
\n ", "required": true }, "SshUsername": { "shape_name": "String", "type": "string", "documentation": "\nThe user's SSH user name.
\n " }, "SshPublicKey": { "shape_name": "String", "type": "string", "documentation": "\nThe user's public SSH key.
\n " }, "AllowSelfManagement": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether users can specify their own SSH public key through the My Settings page. For more information, see\n .
\n " } }, "documentation": null }, "output": { "shape_name": "CreateUserProfileResult", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\nThe user's IAM ARN.
\n " } }, "documentation": "Contains the response to a CreateUserProfile request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " } ], "documentation": "\nCreates a new user profile.
\nRequired Permissions: To use this action, an IAM user must have an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DeleteApp": { "name": "DeleteApp", "input": { "shape_name": "DeleteAppRequest", "type": "structure", "members": { "AppId": { "shape_name": "String", "type": "string", "documentation": "\nThe app ID.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDeletes a specified app.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DeleteInstance": { "name": "DeleteInstance", "input": { "shape_name": "DeleteInstanceRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n ", "required": true }, "DeleteElasticIp": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether to delete the instance Elastic IP address.
\n " }, "DeleteVolumes": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether to delete the instance Amazon EBS volumes.
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDeletes a specified instance. You must stop an instance before you can delete it. For more information, see\n Deleting Instances.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DeleteLayer": { "name": "DeleteLayer", "input": { "shape_name": "DeleteLayerRequest", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\nThe layer ID.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDeletes a specified layer. You must first stop and then delete all associated instances. For more information, see\n How to Delete a Layer.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DeleteStack": { "name": "DeleteStack", "input": { "shape_name": "DeleteStackRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDeletes a specified stack. You must first delete all instances, layers, and apps.\n For more information, see Shut Down a Stack.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DeleteUserProfile": { "name": "DeleteUserProfile", "input": { "shape_name": "DeleteUserProfileRequest", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\nThe user's IAM ARN.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": " \nDeletes a user profile.
\nRequired Permissions: To use this action, an IAM user must have an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DeregisterElasticIp": { "name": "DeregisterElasticIp", "input": { "shape_name": "DeregisterElasticIpRequest", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\nThe Elastic IP address.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDeregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see\n Resource Management.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DeregisterVolume": { "name": "DeregisterVolume", "input": { "shape_name": "DeregisterVolumeRequest", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe volume ID.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDeregisters an Amazon EBS volume.\n The volume can then be registered by another stack. For more information, see\n Resource Management.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeApps": { "name": "DescribeApps", "input": { "shape_name": "DescribeAppsRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe app stack ID. If you use this parameter, DescribeApps returns a description of the\n apps in the specified stack.
An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the\n specified apps. Otherwise, it returns a description of every app.
The app ID.
\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe app stack ID.
\n " }, "Shortname": { "shape_name": "String", "type": "string", "documentation": "\nThe app's short name.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe app name.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the app.
\n " }, "Type": { "shape_name": "AppType", "type": "string", "enum": [ "rails", "php", "nodejs", "static", "other" ], "documentation": "\nThe app type.
\n " }, "AppSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\nThe repository type.
\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\nThe source URL.
" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\nThis parameter depends on the repository type.
\nUsername to the appropriate AWS access key.Username to the user name.This parameter depends on the repository type.
\nPassword to the appropriate AWS secret key.Password to the password.The repository's SSH key.
\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\nThe application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.
\n " } }, "documentation": "\nA Source object that describes the app repository.
The app vhost settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
Whether to enable SSL for the app.
\n " }, "SslConfiguration": { "shape_name": "SslConfiguration", "type": "structure", "members": { "Certificate": { "shape_name": "String", "type": "string", "documentation": "\nThe contents of the certificate's domain.crt file.
\n ", "required": true }, "PrivateKey": { "shape_name": "String", "type": "string", "documentation": "\nThe private key; the contents of the certificate's domain.kex file.
\n ", "required": true }, "Chain": { "shape_name": "String", "type": "string", "documentation": "\nOptional. Can be used to specify an intermediate certificate authority key or client authentication.
\n " } }, "documentation": "\nAn SslConfiguration object with the SSL configuration.
The contents of the stack attributes bag.
\n " }, "CreatedAt": { "shape_name": "String", "type": "string", "documentation": "\nWhen the app was created.
\n " } }, "documentation": "\nA description of the app.
\n " }, "documentation": "\n An array ofApp objects that describe the specified apps.\n "
}
},
"documentation": "Contains the response to a DescribeApps request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nRequests a description of a specified set of apps.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeCommands": { "name": "DescribeCommands", "input": { "shape_name": "DescribeCommandsRequest", "type": "structure", "members": { "DeploymentId": { "shape_name": "String", "type": "string", "documentation": "\nThe deployment ID. If you include this parameter, DescribeCommands returns a description of the commands\n associated with the specified deployment.
The instance ID. If you include this parameter, DescribeCommands returns a description of the commands\n associated with the specified instance.
An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands.\n Otherwise, it returns a description of every command.
The command ID.
\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance where the command was executed.
\n " }, "DeploymentId": { "shape_name": "String", "type": "string", "documentation": "\nThe command deployment ID.
\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\nDate and time when the command was run.
\n " }, "AcknowledgedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\nDate and time when the command was acknowledged.
\n " }, "CompletedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\nDate when the command completed.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe command status:
\nThe command exit code.
\n " }, "LogUrl": { "shape_name": "String", "type": "string", "documentation": "\nThe URL of the command log.
\n " }, "Type": { "shape_name": "String", "type": "string", "documentation": "\nThe command type:
\ndeployrollbackstartstoprestartundeployupdate_dependenciesinstall_dependenciesupdate_custom_cookbooksexecute_recipesDescribes a command.
\n " }, "documentation": "\nAn array of Command objects that describe each of the specified commands.
Contains the response to a DescribeCommands request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDescribes the results of specified commands.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeDeployments": { "name": "DescribeDeployments", "input": { "shape_name": "DescribeDeploymentsRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID. If you include this parameter, DescribeDeployments returns a description of the commands\n associated with the specified stack.
The app ID. If you include this parameter, DescribeDeployments returns a description of the commands\n associated with the specified app.
An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the\n specified deployments. Otherwise, it returns a description of every deployment.
The deployment ID.
\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n " }, "AppId": { "shape_name": "String", "type": "string", "documentation": "\nThe app ID.
\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\nDate when the deployment was created.
\n " }, "CompletedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\nDate when the deployment completed.
\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe deployment duration.
\n " }, "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\nThe user's IAM ARN.
\n " }, "Comment": { "shape_name": "String", "type": "string", "documentation": "\nA user-defined comment.
\n " }, "Command": { "shape_name": "DeploymentCommand", "type": "structure", "members": { "Name": { "shape_name": "DeploymentCommandName", "type": "string", "enum": [ "install_dependencies", "update_dependencies", "update_custom_cookbooks", "execute_recipes", "deploy", "rollback", "start", "stop", "restart", "undeploy" ], "documentation": "\nSpecifies the deployment operation. You can specify only one command.
\nFor stacks, the available commands are:
\nexecute_recipes: Execute the recipes that are specified by the Args parameter.install_dependencies: Installs the stack's dependencies.update_custom_cookbooks: Update the stack's custom cookbooks.update_dependencies: Update the stack's dependencies.For apps, the available commands are:
\ndeploy: Deploy the app.rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks stores the previous version,\n up to a maximum of five versions. You can use this command to roll an app back as many as four versions.start: Start the app's web or application server.stop: Stop the app's web or application server.restart: Restart the app's web or application server.undeploy: Undeploy the app.An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes\n command.
Used to specify a deployment operation.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe deployment status:
\nA string that contains user-defined custom JSON. It is used to override the corresponding default stack configuration JSON values for \n stack. The string should be in the following format and must escape characters such as '\"'.:
\n\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
\n " }, "InstanceIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nThe IDs of the target instances.
\n " } }, "documentation": "\nDescribes a deployment of a stack or app.
\n " }, "documentation": "\nAn array of Deployment objects that describe the deployments.
Contains the response to a DescribeDeployments request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nRequests a description of a specified set of deployments.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeElasticIps": { "name": "DescribeElasticIps", "input": { "shape_name": "DescribeElasticIpsRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID. If you include this parameter, DescribeElasticIps returns a description of the\n Elastic IP addresses associated with the specified instance.
A stack ID. If you include this parameter, DescribeElasticIps returns a description of\n the Elastic IP addresses that are registered with the specified stack.
An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of\n the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.
The IP address.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name.
\n " }, "Domain": { "shape_name": "String", "type": "string", "documentation": "\nThe domain.
\n " }, "Region": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS region. For more information, see Regions and Endpoints.
\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance that the address is attached to.
\n " } }, "documentation": "\nDescribes an Elastic IP address.
\n " }, "documentation": "\nAn ElasticIps object that describes the specified Elastic IP addresses.
Contains the response to a DescribeElasticIps request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDescribes Elastic IP addresses.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeElasticLoadBalancers": { "name": "DescribeElasticLoadBalancers", "input": { "shape_name": "DescribeElasticLoadBalancersRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nA stack ID. The action describes the stack's Elastic Load Balancing instances.
\n " }, "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nA list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.
\n " } }, "documentation": null }, "output": { "shape_name": "DescribeElasticLoadBalancersResult", "type": "structure", "members": { "ElasticLoadBalancers": { "shape_name": "ElasticLoadBalancers", "type": "list", "members": { "shape_name": "ElasticLoadBalancer", "type": "structure", "members": { "ElasticLoadBalancerName": { "shape_name": "String", "type": "string", "documentation": "\nThe Elastic Load Balancing instance's name.
\n " }, "Region": { "shape_name": "String", "type": "string", "documentation": "\nThe instance's AWS region.
\n " }, "DnsName": { "shape_name": "String", "type": "string", "documentation": "\nThe instance's public DNS name.
\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the stack that the instance is associated with.
\n " }, "LayerId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the layer that the instance is attached to.
\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe VPC ID.
\n " }, "AvailabilityZones": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nA list of Availability Zones.
\n " }, "SubnetIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nA list of subnet IDs, if the stack is running in a VPC.
\n " }, "Ec2InstanceIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nA list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.
\n " } }, "documentation": "\nDescribes an Elastic Load Balancing instance.
\n " }, "documentation": "\nA list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.
Contains the response to a DescribeElasticLoadBalancers request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDescribes a stack's Elastic Load Balancing instances.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeInstances": { "name": "DescribeInstances", "input": { "shape_name": "DescribeInstancesRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nA stack ID. If you use this parameter, DescribeInstances returns\n descriptions of the instances associated with the specified stack.
A layer ID. If you use this parameter, DescribeInstances returns\n descriptions of the instances associated with the specified layer.
An array of instance IDs to be described. If you use this parameter, \n DescribeInstances returns a description of the specified instances. Otherwise, it returns\n a description of every instance.
The instance ID.
\n " }, "Ec2InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the associated Amazon EC2 instance.
\n " }, "Hostname": { "shape_name": "String", "type": "string", "documentation": "\nThe instance host name.
\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n " }, "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array containing the instance layer IDs.
\n " }, "SecurityGroupIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array containing the instance security group IDs.
\n " }, "InstanceType": { "shape_name": "String", "type": "string", "documentation": "\nThe instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster.\n For more information, see Instance Families and Types.\n The parameter values that specify the various types are in the API Name column of the Available Instance Types table.
\n " }, "InstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\nThe ARN of the instance's IAM profile. For more information about IAM ARNs, see\n Using Identifiers.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe instance status:
\nrequestedbootingrunning_setuponlinesetup_failedstart_failedterminatingterminatedstoppedconnection_lostThe instance operating system.
\n " }, "AmiId": { "shape_name": "String", "type": "string", "documentation": "\nA custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs:\n Amazon Linux or Ubuntu 12.04 LTS. For more information, see\n Instances
\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe instance Availability Zone. For more information, see\n Regions and Endpoints.
\n " }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance's subnet ID, if the stack is running in a VPC.
\n " }, "PublicDns": { "shape_name": "String", "type": "string", "documentation": "\nThe instance public DNS name.
\n " }, "PrivateDns": { "shape_name": "String", "type": "string", "documentation": "\nThe instance private DNS name.
\n " }, "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\nThe instance public IP address.
\n " }, "PrivateIp": { "shape_name": "String", "type": "string", "documentation": "\nThe instance private IP address.
\n " }, "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\nThe instance Elastic IP address .
\n " }, "AutoScalingType": { "shape_name": "AutoScalingType", "type": "string", "enum": [ "load", "timer" ], "documentation": "\nThe instance's auto scaling type, which has three possible values:
\nThe instance SSH key name.
\n " }, "SshHostRsaKeyFingerprint": { "shape_name": "String", "type": "string", "documentation": "\nThe SSH key's RSA fingerprint.
\n " }, "SshHostDsaKeyFingerprint": { "shape_name": "String", "type": "string", "documentation": "\nThe SSH key's DSA fingerprint.
\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\nThe time that the instance was created.
\n " }, "LastServiceErrorId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the last service error. For more information, call DescribeServiceErrors.
\n " }, "Architecture": { "shape_name": "Architecture", "type": "string", "enum": [ "x86_64", "i386" ], "documentation": "\nThe instance architecture, \"i386\" or \"x86_64\".
\n " }, "RootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\nThe instance root device type. For more information, see\n Storage for the Root Device.
\n " }, "RootDeviceVolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe root device volume ID.
\n " }, "InstallUpdatesOnBoot": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether to install operating system and package updates when the instance boots. The default value is true.\n If this value is set to false, you must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n
true, to ensure that your instances have the latest security updates.Describes an instance.
\n " }, "documentation": "\nAn array of Instance objects that describe the instances.
Contains the response to a DescribeInstances request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nRequests a description of a set of instances.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeLayers": { "name": "DescribeLayers", "input": { "shape_name": "DescribeLayersRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n " }, "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of layer IDs that specify the layers to be described. If you omit this parameter,\n DescribeLayers returns a description of every layer in the specified stack.
The layer stack ID.
\n " }, "LayerId": { "shape_name": "String", "type": "string", "documentation": "\nThe layer ID.
\n " }, "Type": { "shape_name": "LayerType", "type": "string", "enum": [ "lb", "web", "php-app", "rails-app", "nodejs-app", "memcached", "db-master", "monitoring-master", "custom" ], "documentation": "\nThe layer type, which must be one of the following:
\nThe layer name.
\n " }, "Shortname": { "shape_name": "String", "type": "string", "documentation": "\nThe layer short name.
\n " }, "Attributes": { "shape_name": "LayerAttributes", "type": "map", "keys": { "shape_name": "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" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nThe layer attributes.
\n " }, "CustomInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\nThe ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see\n Using Identifiers.
\n " }, "CustomSecurityGroupIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": " \nAn array containing the layer's custom security group IDs.
\n " }, "DefaultSecurityGroupNames": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array containing the layer's security group names.
\n " }, "Packages": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of Package objects that describe the layer's packages.
The volume mount point. For example \"/dev/sdh\".
\n ", "required": true }, "RaidLevel": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe volume RAID level.
\n " }, "NumberOfDisks": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe number of disks in the volume.
\n ", "required": true }, "Size": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe volume size.
\n ", "required": true } }, "documentation": "\nDescribes an Amazon EBS volume configuration.
\n " }, "documentation": "\nA VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Whether auto healing is disabled for the layer.
\n " }, "AutoAssignElasticIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether to automatically assign an Elastic\n IP address to the layer's instances.\n For more information, see How to Edit a Layer.
\n " }, "AutoAssignPublicIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nFor stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.\n For more information, see How to Edit a Layer.
\n " }, "DefaultRecipes": { "shape_name": "Recipes", "type": "structure", "members": { "Setup": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of custom recipe names to be run following a setup event.
An array of custom recipe names to be run following a configure event.
An array of custom recipe names to be run following a deploy event.
An array of custom recipe names to be run following a undeploy event.
An array of custom recipe names to be run following a shutdown event.
AWS OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown.\n For each layer, AWS OpsWorks runs a set of standard recipes for each event.\n In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks runs custom event recipes after the standard recipes.\n LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.\n
To specify a recipe, use the cookbook's directory name in the repository\n followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup\n specifies the dbsetup.rb recipe in the repository's phpapp2 folder.\n
\n " }, "CustomRecipes": { "shape_name": "Recipes", "type": "structure", "members": { "Setup": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of custom recipe names to be run following a setup event.
An array of custom recipe names to be run following a configure event.
An array of custom recipe names to be run following a deploy event.
An array of custom recipe names to be run following a undeploy event.
An array of custom recipe names to be run following a shutdown event.
A LayerCustomRecipes object that specifies the layer's custom recipes.
Date when the layer was created.
\n " }, "InstallUpdatesOnBoot": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether to install operating system and package updates when the instance boots. The default value is true.\n If this value is set to false, you must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n
true, to ensure that your instances have the latest security updates.Describes a layer.
\n " }, "documentation": "\nAn array of Layer objects that describe the layers.
Contains the response to a DescribeLayers request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nRequests a description of one or more layers in a specified stack.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeLoadBasedAutoScaling": { "name": "DescribeLoadBasedAutoScaling", "input": { "shape_name": "DescribeLoadBasedAutoScalingRequest", "type": "structure", "members": { "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of layer IDs.
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeLoadBasedAutoScalingResult", "type": "structure", "members": { "LoadBasedAutoScalingConfigurations": { "shape_name": "LoadBasedAutoScalingConfigurations", "type": "list", "members": { "shape_name": "LoadBasedAutoScalingConfiguration", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\nThe layer ID.
\n " }, "Enable": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether load-based auto scaling is enabled for the layer.
\n " }, "UpScaling": { "shape_name": "AutoScalingThresholds", "type": "structure", "members": { "InstanceCount": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe number of instances to add or remove when the load exceeds a threshold.
\n " }, "ThresholdsWaitTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\nThe amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
\n " }, "IgnoreMetricsTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\nThe amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics\n and not raise any additional scaling events.\n For example, AWS OpsWorks adds new instances following an upscaling event but the instances\n won't start reducing the load until they have been booted and configured.\n There is no point in raising additional scaling events during that operation, which typically takes several minutes.\n IgnoreMetricsTime allows you to direct AWS OpsWorks to not raise any scaling events long enough\n to get the new instances online.
The CPU utilization threshold, as a percent of the available CPU.
\n " }, "MemoryThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\nThe memory utilization threshold, as a percent of the available memory.
\n " }, "LoadThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\nThe load threshold. For more information about how load is computed, see\n Load (computing).
\n " } }, "documentation": "\nA LoadBasedAutoscalingInstruction object that describes the upscaling configuration, which \n defines how and when AWS OpsWorks increases the number of instances.
The number of instances to add or remove when the load exceeds a threshold.
\n " }, "ThresholdsWaitTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\nThe amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
\n " }, "IgnoreMetricsTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\nThe amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics\n and not raise any additional scaling events.\n For example, AWS OpsWorks adds new instances following an upscaling event but the instances\n won't start reducing the load until they have been booted and configured.\n There is no point in raising additional scaling events during that operation, which typically takes several minutes.\n IgnoreMetricsTime allows you to direct AWS OpsWorks to not raise any scaling events long enough\n to get the new instances online.
The CPU utilization threshold, as a percent of the available CPU.
\n " }, "MemoryThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\nThe memory utilization threshold, as a percent of the available memory.
\n " }, "LoadThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\nThe load threshold. For more information about how load is computed, see\n Load (computing).
\n " } }, "documentation": "\nA LoadBasedAutoscalingInstruction object that describes the downscaling configuration, which \n defines how and when AWS OpsWorks reduces the number of instances.
Describes a layer's load-based auto scaling configuration.
\n " }, "documentation": "\nAn array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.
Contains the response to a DescribeLoadBasedAutoScaling request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDescribes load-based auto scaling configurations for specified layers.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeMyUserProfile": { "name": "DescribeMyUserProfile", "input": null, "output": { "shape_name": "DescribeMyUserProfileResult", "type": "structure", "members": { "UserProfile": { "shape_name": "SelfUserProfile", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\nThe user's IAM ARN.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe user's name.
\n " }, "SshUsername": { "shape_name": "String", "type": "string", "documentation": "\nThe user's SSH user name.
\n " }, "SshPublicKey": { "shape_name": "String", "type": "string", "documentation": "\nThe user's SSH public key.
\n " } }, "documentation": "\nA UserProfile object that describes the user's SSH information.
Contains the response to a DescribeMyUserProfile request.
Describes a user's SSH information.
\nRequired Permissions: To use this action, an IAM user must have self-management enabled\n or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribePermissions": { "name": "DescribePermissions", "input": { "shape_name": "DescribePermissionsRequest", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\nThe user's IAM ARN. For more information about IAM ARNs, see\n Using Identifiers.
\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n " } }, "documentation": null }, "output": { "shape_name": "DescribePermissionsResult", "type": "structure", "members": { "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nA stack ID.
\n " }, "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see\n Using Identifiers.
\n " }, "AllowSsh": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether the user can use SSH.
\n " }, "AllowSudo": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether the user can use sudo.
\n " }, "Level": { "shape_name": "String", "type": "string", "documentation": "\nThe user's permission level, which must be the following:
\ndenyshowdeploymanageiam_onlyFor more information on the permissions associated with these levels, see\n Managing User Permissions
\n " } }, "documentation": "\nDescribes stack or user permissions.
\n " }, "documentation": "\nAn array of Permission objects that describe the stack permissions.
Permission object with permissions for each of the stack IAM ARNs.Permission object with permissions for each of the user's stack IDs.Permission object with permissions for the specified stack and IAM ARN.Contains the response to a DescribePermissions request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDescribes the permissions for a specified stack.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeRaidArrays": { "name": "DescribeRaidArrays", "input": { "shape_name": "DescribeRaidArraysRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID. If you use this parameter, DescribeRaidArrays returns\n descriptions of the RAID arrays associated with the specified instance.
An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns\n descriptions of the specified arrays. Otherwise, it returns a description of every array.
The array ID.
\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe array name.
\n " }, "RaidLevel": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe RAID level.
\n " }, "NumberOfDisks": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe number of disks in the array.
\n " }, "Size": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe array's size.
\n " }, "Device": { "shape_name": "String", "type": "string", "documentation": "\nThe array's Linux device. For example /dev/mdadm0.
\n " }, "MountPoint": { "shape_name": "String", "type": "string", "documentation": "\nThe array's mount point.
\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe array's Availability Zone. For more information, see\n Regions and Endpoints.
\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\nWhen the RAID array was created.
\n " } }, "documentation": "\nDescribes an instance's RAID array.
\n " }, "documentation": "\nA RaidArrays object that describes the specified RAID arrays.
Contains the response to a DescribeRaidArrays request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDescribe an instance's RAID arrays.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions.\n For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeServiceErrors": { "name": "DescribeServiceErrors", "input": { "shape_name": "DescribeServiceErrorsRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID. If you use this parameter, DescribeServiceErrors returns\n descriptions of the errors associated with the specified stack.
The instance ID. If you use this parameter, DescribeServiceErrors returns\n descriptions of the errors associated with the specified instance.
An array of service error IDs. If you use this parameter, DescribeServiceErrors returns\n descriptions of the specified errors. Otherwise, it returns a description of every error.
The error ID.
\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n " }, "Type": { "shape_name": "String", "type": "string", "documentation": "\nThe error type.
\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nA message that describes the error.
\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\nWhen the error occurred.
\n " } }, "documentation": "\nDescribes an AWS OpsWorks service error.
\n " }, "documentation": "\nAn array of ServiceError objects that describe the specified service errors.
Contains the response to a DescribeServiceErrors request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDescribes AWS OpsWorks service errors.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeStackSummary": { "name": "DescribeStackSummary", "input": { "shape_name": "DescribeStackSummaryRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeStackSummaryResult", "type": "structure", "members": { "StackSummary": { "shape_name": "StackSummary", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe stack name.
\n " }, "LayersCount": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe number of layers.
\n " }, "AppsCount": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe number of apps.
\n " }, "InstancesCount": { "shape_name": "InstancesCount", "type": "structure", "members": { "Booting": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe number of instances with booting status.
The number of instances with connection_lost status.
The number of instances with pending status.
The number of instances with rebooting status.
The number of instances with requested status.
The number of instances with running_setup status.
The number of instances with setup_failed status.
The number of instances with shutting_down status.
The number of instances with start_failed status.
The number of instances with stopped status.
The number of instances with terminated status.
The number of instances with terminating status.
An InstancesCount object with the number of instances in each status.
A StackSummary object that contains the results.
Contains the response to a DescribeStackSummary request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDescribes the number of layers and apps in a specified stack, and the number of instances in\n each state, such as running_setup or online.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
" }, "DescribeStacks": { "name": "DescribeStacks", "input": { "shape_name": "DescribeStacksRequest", "type": "structure", "members": { "StackIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of stack IDs that specify the stacks to be described. If you omit this parameter,\n DescribeStacks returns a description of every stack.
The stack ID.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe stack name.
\n " }, "Region": { "shape_name": "String", "type": "string", "documentation": "\nThe stack AWS region, such as \"us-east-1\". For more information about AWS regions, see\n Regions and Endpoints.
\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe VPC ID, if the stack is running in a VPC.
\n " }, "Attributes": { "shape_name": "StackAttributes", "type": "map", "keys": { "shape_name": "StackAttributesKeys", "type": "string", "enum": [ "Color" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nThe contents of the stack's attributes bag.
\n " }, "ServiceRoleArn": { "shape_name": "String", "type": "string", "documentation": "\nThe stack AWS Identity and Access Management (IAM) role.
\n " }, "DefaultInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\nThe 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\n Using Identifiers.
\n " }, "DefaultOs": { "shape_name": "String", "type": "string", "documentation": "\nThe stack's default operating system, which must be set to Amazon Linux or Ubuntu 12.04 LTS.\n The default option is Amazon Linux.\n
The stack host name theme, with spaces replaced by underscores.
\n " }, "DefaultAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe stack's default Availability Zone. For more information, see\n Regions and Endpoints.
\n " }, "DefaultSubnetId": { "shape_name": "String", "type": "string", "documentation": "\nThe default subnet ID, if the stack is running in a VPC.
\n " }, "CustomJson": { "shape_name": "String", "type": "string", "documentation": "\nA string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values.\nThe string should be in the following format and must escape characters such as '\"'.:
\n\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
\n " }, "ConfigurationManager": { "shape_name": "StackConfigurationManager", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name. This parameter must be set to \"Chef\".
\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\nThe Chef version. This parameter must be set to \"0.9\" or \"11.4\". The default value is \"0.9\".\n However, we expect to change the default value to \"11.4\" in September 2013.
\n " } }, "documentation": "\nThe configuration manager.
\n " }, "UseCustomCookbooks": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether the stack uses custom cookbooks.
\n " }, "CustomCookbooksSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\nThe repository type.
\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\nThe source URL.
" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\nThis parameter depends on the repository type.
\nUsername to the appropriate AWS access key.Username to the user name.This parameter depends on the repository type.
\nPassword to the appropriate AWS secret key.Password to the password.The repository's SSH key.
\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\nThe application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.
\n " } }, "documentation": "\nContains the information required to retrieve an app or cookbook from a repository. For more information, see\n Creating Apps or\n Custom Recipes and Cookbooks.
\n " }, "DefaultSshKeyName": { "shape_name": "String", "type": "string", "documentation": "\nA default SSH key for the stack's instances. You can override this value when you create or update an instance.
\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\nDate when the stack was created.
\n " }, "DefaultRootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\nThe default root device type. This value is used by default for all instances in the cloned stack,\n but you can override it when you create an instance. For more information, see\n Storage for the Root Device.
\n " } }, "documentation": "\nDescribes a stack.
\n " }, "documentation": "\nAn array of Stack objects that describe the stacks.
Contains the response to a DescribeStacks request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nRequests a description of one or more stacks.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeTimeBasedAutoScaling": { "name": "DescribeTimeBasedAutoScaling", "input": { "shape_name": "DescribeTimeBasedAutoScalingRequest", "type": "structure", "members": { "InstanceIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of instance IDs.
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeTimeBasedAutoScalingResult", "type": "structure", "members": { "TimeBasedAutoScalingConfigurations": { "shape_name": "TimeBasedAutoScalingConfigurations", "type": "list", "members": { "shape_name": "TimeBasedAutoScalingConfiguration", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n " }, "AutoScalingSchedule": { "shape_name": "WeeklyAutoScalingSchedule", "type": "structure", "members": { "Monday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Monday.
\n " }, "Tuesday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Tuesday.
\n " }, "Wednesday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Wednesday.
\n " }, "Thursday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Thursday.
\n " }, "Friday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Friday.
\n " }, "Saturday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Saturday.
\n " }, "Sunday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Sunday.
\n " } }, "documentation": "\nA WeeklyAutoScalingSchedule object with the instance schedule.
Describes an instance's time-based auto scaling configuration.
\n " }, "documentation": "\nAn array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.
Contains the response to a DescribeTimeBasedAutoScaling request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDescribes time-based auto scaling configurations for specified instances.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeUserProfiles": { "name": "DescribeUserProfiles", "input": { "shape_name": "DescribeUserProfilesRequest", "type": "structure", "members": { "IamUserArns": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of IAM user ARNs that identify the users to be described.
\n " } }, "documentation": null }, "output": { "shape_name": "DescribeUserProfilesResult", "type": "structure", "members": { "UserProfiles": { "shape_name": "UserProfiles", "type": "list", "members": { "shape_name": "UserProfile", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\nThe user's IAM ARN.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe user's name.
\n " }, "SshUsername": { "shape_name": "String", "type": "string", "documentation": "\nThe user's SSH user name.
\n " }, "SshPublicKey": { "shape_name": "String", "type": "string", "documentation": "\nThe user's SSH public key.
\n " }, "AllowSelfManagement": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether users can specify their own SSH public key through the My Settings page. For more information, see\n Managing User Permissions.
\n " } }, "documentation": "\nDescribes a user's SSH information.
\n " }, "documentation": "\nA Users object that describes the specified users.
Contains the response to a DescribeUserProfiles request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": " \nDescribe specified users.
\nRequired Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions.\n For more information on user permissions, see\n Managing User Permissions.
\n " }, "DescribeVolumes": { "name": "DescribeVolumes", "input": { "shape_name": "DescribeVolumesRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID. If you use this parameter, DescribeVolumes returns\n descriptions of the volumes associated with the specified instance.
A stack ID. The action describes the stack's registered Amazon EBS volumes.
\n " }, "RaidArrayId": { "shape_name": "String", "type": "string", "documentation": "\nThe RAID array ID. If you use this parameter, DescribeVolumes returns\n descriptions of the volumes associated with the specified RAID array.
Am array of volume IDs. If you use this parameter, DescribeVolumes returns\n descriptions of the specified volumes. Otherwise, it returns a description of every volume.
The volume ID.
\n " }, "Ec2VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon EC2 volume ID.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe volume name.
\n " }, "RaidArrayId": { "shape_name": "String", "type": "string", "documentation": "\nThe RAID array ID.
\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe value returned by\n DescribeVolumes.
\n " }, "Size": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe volume size.
\n " }, "Device": { "shape_name": "String", "type": "string", "documentation": "\nThe device name.
\n " }, "MountPoint": { "shape_name": "String", "type": "string", "documentation": "\nThe volume mount point. For example \"/dev/sdh\".
\n " }, "Region": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS region. For more information about AWS regions, see\n Regions and Endpoints.
\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": " \nThe volume Availability Zone. For more information, see\n Regions and Endpoints.
\n " } }, "documentation": "\nDescribes an instance's Amazon EBS volume.
\n " }, "documentation": "\nAn array of volume IDs.
\n " } }, "documentation": "Contains the response to a DescribeVolumes request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDescribes an instance's Amazon EBS volumes.
\nRequired Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DetachElasticLoadBalancer": { "name": "DetachElasticLoadBalancer", "input": { "shape_name": "DetachElasticLoadBalancerRequest", "type": "structure", "members": { "ElasticLoadBalancerName": { "shape_name": "String", "type": "string", "documentation": "\nThe Elastic Load Balancing instance's name.
\n ", "required": true }, "LayerId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the layer that the Elastic Load Balancing instance is attached to.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDetaches a specified Elastic Load Balancing instance from its layer.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "DisassociateElasticIp": { "name": "DisassociateElasticIp", "input": { "shape_name": "DisassociateElasticIpRequest", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\nThe Elastic IP address.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nDisassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see\n Resource Management.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "GetHostnameSuggestion": { "name": "GetHostnameSuggestion", "input": { "shape_name": "GetHostnameSuggestionRequest", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\nThe layer ID.
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "GetHostnameSuggestionResult", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\nThe layer ID.
\n " }, "Hostname": { "shape_name": "String", "type": "string", "documentation": "\nThe generated host name.
\n " } }, "documentation": "Contains the response to a GetHostnameSuggestion request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nGets a generated host name for the specified layer, based on the current host name theme.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "RebootInstance": { "name": "RebootInstance", "input": { "shape_name": "RebootInstanceRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nReboots a specified instance. For more information, see\n Starting, Stopping, and Rebooting Instances.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "RegisterElasticIp": { "name": "RegisterElasticIp", "input": { "shape_name": "RegisterElasticIpRequest", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\nThe Elastic IP address.
\n ", "required": true }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "RegisterElasticIpResult", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\nThe Elastic IP address.
\n " } }, "documentation": "\nContains the response to a RegisterElasticIp request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nRegisters an Elastic IP address with a specified stack. An address can be\n registered with only one stack at a time. If the address is already registered, you must first deregister it\n by calling DeregisterElasticIp. For more information, see\n Resource Management.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
" }, "RegisterVolume": { "name": "RegisterVolume", "input": { "shape_name": "RegisterVolumeRequest", "type": "structure", "members": { "Ec2VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon EBS volume ID.
\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "RegisterVolumeResult", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe volume ID.
\n " } }, "documentation": "\nContains the response to a RegisterVolume request.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nRegisters an Amazon EBS volume with a specified stack. A volume can be\n registered with only one stack at a time. If the volume is already registered, you must first deregister it\n by calling DeregisterVolume. For more information, see\n Resource Management.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "SetLoadBasedAutoScaling": { "name": "SetLoadBasedAutoScaling", "input": { "shape_name": "SetLoadBasedAutoScalingRequest", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\nThe layer ID.
\n ", "required": true }, "Enable": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nEnables load-based auto scaling for the layer.
\n " }, "UpScaling": { "shape_name": "AutoScalingThresholds", "type": "structure", "members": { "InstanceCount": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe number of instances to add or remove when the load exceeds a threshold.
\n " }, "ThresholdsWaitTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\nThe amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
\n " }, "IgnoreMetricsTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\nThe amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics\n and not raise any additional scaling events.\n For example, AWS OpsWorks adds new instances following an upscaling event but the instances\n won't start reducing the load until they have been booted and configured.\n There is no point in raising additional scaling events during that operation, which typically takes several minutes.\n IgnoreMetricsTime allows you to direct AWS OpsWorks to not raise any scaling events long enough\n to get the new instances online.
The CPU utilization threshold, as a percent of the available CPU.
\n " }, "MemoryThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\nThe memory utilization threshold, as a percent of the available memory.
\n " }, "LoadThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\nThe load threshold. For more information about how load is computed, see\n Load (computing).
\n " } }, "documentation": "\nAn AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds\n these thresholds for a specified amount of time, AWS OpsWorks starts a specified number of instances.
The number of instances to add or remove when the load exceeds a threshold.
\n " }, "ThresholdsWaitTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\nThe amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
\n " }, "IgnoreMetricsTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\nThe amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics\n and not raise any additional scaling events.\n For example, AWS OpsWorks adds new instances following an upscaling event but the instances\n won't start reducing the load until they have been booted and configured.\n There is no point in raising additional scaling events during that operation, which typically takes several minutes.\n IgnoreMetricsTime allows you to direct AWS OpsWorks to not raise any scaling events long enough\n to get the new instances online.
The CPU utilization threshold, as a percent of the available CPU.
\n " }, "MemoryThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\nThe memory utilization threshold, as a percent of the available memory.
\n " }, "LoadThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\nThe load threshold. For more information about how load is computed, see\n Load (computing).
\n " } }, "documentation": "\nAn AutoScalingThresholds object with the downscaling threshold configuration. If the load falls\n below these thresholds for a specified amount of time, AWS OpsWorks stops a specified number of instances.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nSpecify the load-based auto scaling configuration for a specified layer. For more information, see\n Managing Load\n with Time-based and Load-based Instances.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "SetPermission": { "name": "SetPermission", "input": { "shape_name": "SetPermissionRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n ", "required": true }, "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\nThe user's IAM ARN.
\n ", "required": true }, "AllowSsh": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nThe user is allowed to use SSH to communicate with the instance.
\n " }, "AllowSudo": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nThe user is allowed to use sudo to elevate privileges.
\n " }, "Level": { "shape_name": "String", "type": "string", "documentation": "\nThe user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.
\ndenyshowdeploymanageiam_onlyFor more information on the permissions associated with these levels, see\n Managing User Permissions
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nSpecifies a stack's permissions. For more information, see\n Security and Permissions.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "SetTimeBasedAutoScaling": { "name": "SetTimeBasedAutoScaling", "input": { "shape_name": "SetTimeBasedAutoScalingRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n ", "required": true }, "AutoScalingSchedule": { "shape_name": "WeeklyAutoScalingSchedule", "type": "structure", "members": { "Monday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Monday.
\n " }, "Tuesday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Tuesday.
\n " }, "Wednesday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Wednesday.
\n " }, "Thursday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Thursday.
\n " }, "Friday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Friday.
\n " }, "Saturday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Saturday.
\n " }, "Sunday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\nThe schedule for Sunday.
\n " } }, "documentation": "\nAn AutoScalingSchedule with the instance schedule.
The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nSpecify the time-based auto scaling configuration for a specified instance. For more information,\n see Managing Load\n with Time-based and Load-based Instances.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "StartInstance": { "name": "StartInstance", "input": { "shape_name": "StartInstanceRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nStarts a specified instance. For more information, see\n Starting, Stopping,\n and Rebooting Instances.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "StartStack": { "name": "StartStack", "input": { "shape_name": "StartStackRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nStarts stack's instances.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "StopInstance": { "name": "StopInstance", "input": { "shape_name": "StopInstanceRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nStops a specified instance. When you stop a standard instance, the data disappears and must\n be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data.\n For more information, see\n Starting, Stopping,\n and Rebooting Instances.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "StopStack": { "name": "StopStack", "input": { "shape_name": "StopStackRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nStops a specified stack.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "UnassignVolume": { "name": "UnassignVolume", "input": { "shape_name": "UnassignVolumeRequest", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe volume ID.
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nUnassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see\n Resource Management.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "UpdateApp": { "name": "UpdateApp", "input": { "shape_name": "UpdateAppRequest", "type": "structure", "members": { "AppId": { "shape_name": "String", "type": "string", "documentation": "\nThe app ID.
\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe app name.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the app.
\n " }, "Type": { "shape_name": "AppType", "type": "string", "enum": [ "rails", "php", "nodejs", "static", "other" ], "documentation": "\nThe app type.
\n " }, "AppSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\nThe repository type.
\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\nThe source URL.
" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\nThis parameter depends on the repository type.
\nUsername to the appropriate AWS access key.Username to the user name.This parameter depends on the repository type.
\nPassword to the appropriate AWS secret key.Password to the password.The repository's SSH key.
\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\nThe application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.
\n " } }, "documentation": "\nA Source object that specifies the app repository.
The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
Whether SSL is enabled for the app.
\n " }, "SslConfiguration": { "shape_name": "SslConfiguration", "type": "structure", "members": { "Certificate": { "shape_name": "String", "type": "string", "documentation": "\nThe contents of the certificate's domain.crt file.
\n ", "required": true }, "PrivateKey": { "shape_name": "String", "type": "string", "documentation": "\nThe private key; the contents of the certificate's domain.kex file.
\n ", "required": true }, "Chain": { "shape_name": "String", "type": "string", "documentation": "\nOptional. Can be used to specify an intermediate certificate authority key or client authentication.
\n " } }, "documentation": "\nAn SslConfiguration object with the SSL configuration.
One or more user-defined key/value pairs to be added to the stack attributes bag.
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nUpdates a specified app.
\nRequired Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack,\n or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "UpdateElasticIp": { "name": "UpdateElasticIp", "input": { "shape_name": "UpdateElasticIpRequest", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\nThe address.
\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe new name.
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nUpdates a registered Elastic IP address's name. For more information, see\n Resource Management.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "UpdateInstance": { "name": "UpdateInstance", "input": { "shape_name": "UpdateInstanceRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID.
\n ", "required": true }, "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nThe instance's layer IDs.
\n " }, "InstanceType": { "shape_name": "String", "type": "string", "documentation": "\nThe instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster.\n For more information, see Instance Families and Types.\n The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
\n " }, "AutoScalingType": { "shape_name": "AutoScalingType", "type": "string", "enum": [ "load", "timer" ], "documentation": "\nThe instance's auto scaling type, which has three possible values:
\nThe instance host name.
\n " }, "Os": { "shape_name": "String", "type": "string", "documentation": "\nThe instance operating system, which must be set to one of the following.
\nAmazon Linux or Ubuntu 12.04 LTS\nCustom\nThe default option is Amazon Linux. If you set this parameter to Custom, you must use the\n CreateInstance action's AmiId parameter to specify\n the custom AMI that you want to use. For more information on the standard operating systems, see\n Operating SystemsFor more information\n on how to use custom AMIs with OpsWorks, see\n Using Custom AMIs.
A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs:\n Amazon Linux or Ubuntu 12.04 LTS. For more information, see\n Instances
\n " }, "SshKeyName": { "shape_name": "String", "type": "string", "documentation": "\nThe instance SSH key name.
\n " }, "Architecture": { "shape_name": "Architecture", "type": "string", "enum": [ "x86_64", "i386" ], "documentation": "\nThe instance architecture. Instance types do not necessarily support both architectures.\n For a list of the architectures that are supported by the different instance types, see\n Instance Families and Types.
\n " }, "InstallUpdatesOnBoot": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether to install operating system and package updates when the instance boots. The default value is true.\n To control when updates are installed, set this value to false. You must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n
true, to ensure that your instances have the latest security updates.The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nUpdates a specified instance.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "UpdateLayer": { "name": "UpdateLayer", "input": { "shape_name": "UpdateLayerRequest", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\nThe layer ID.
\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe layer name, which is used by the console.
\n " }, "Shortname": { "shape_name": "String", "type": "string", "documentation": "\nThe layer short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the\n directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format:\n /\\A[a-z0-9\\-\\_\\.]+\\Z/.
\n " }, "Attributes": { "shape_name": "LayerAttributes", "type": "map", "keys": { "shape_name": "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" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nOne or more user-defined key/value pairs to be added to the stack attributes bag.
\n " }, "CustomInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\nThe ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see\n Using Identifiers.
\n " }, "CustomSecurityGroupIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array containing the layer's custom security group IDs.
\n " }, "Packages": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of Package objects that describe the layer's packages.
The volume mount point. For example \"/dev/sdh\".
\n ", "required": true }, "RaidLevel": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe volume RAID level.
\n " }, "NumberOfDisks": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe number of disks in the volume.
\n ", "required": true }, "Size": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\nThe volume size.
\n ", "required": true } }, "documentation": "\nDescribes an Amazon EBS volume configuration.
\n " }, "documentation": "\nA VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Whether to disable auto healing for the layer.
\n " }, "AutoAssignElasticIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether to automatically assign an Elastic\n IP address to the layer's instances.\n For more information, see How to Edit a Layer.
\n " }, "AutoAssignPublicIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nFor stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.\n For more information, see How to Edit a Layer.
\n " }, "CustomRecipes": { "shape_name": "Recipes", "type": "structure", "members": { "Setup": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nAn array of custom recipe names to be run following a setup event.
An array of custom recipe names to be run following a configure event.
An array of custom recipe names to be run following a deploy event.
An array of custom recipe names to be run following a undeploy event.
An array of custom recipe names to be run following a shutdown event.
A LayerCustomRecipes object that specifies the layer's custom recipes.
Whether to install operating system and package updates when the instance boots. The default value is true.\n To control when updates are installed, set this value to false. You must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n
true, to ensure that your instances have the latest security updates.The exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nUpdates a specified layer.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "UpdateMyUserProfile": { "name": "UpdateMyUserProfile", "input": { "shape_name": "UpdateMyUserProfileRequest", "type": "structure", "members": { "SshPublicKey": { "shape_name": "String", "type": "string", "documentation": "\nThe user's SSH public key.
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " } ], "documentation": "\nUpdates a user's SSH public key.
\nRequired Permissions: To use this action, an IAM user must have self-management enabled or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "UpdateStack": { "name": "UpdateStack", "input": { "shape_name": "UpdateStackRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\nThe stack ID.
\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe stack's new name.
\n " }, "Attributes": { "shape_name": "StackAttributes", "type": "map", "keys": { "shape_name": "StackAttributesKeys", "type": "string", "enum": [ "Color" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": " \nOne or more user-defined key/value pairs to be added to the stack attributes bag.
\n " }, "ServiceRoleArn": { "shape_name": "String", "type": "string", "documentation": "\nThe stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf.\n You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see\n Using Identifiers.
\nThe 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\n Using Identifiers.
\n " }, "DefaultOs": { "shape_name": "String", "type": "string", "documentation": "\nThe stack's default operating system, which must be set to Amazon Linux or Ubuntu 12.04 LTS.\n The default option is Amazon Linux.\n
The stack's new host name theme, with spaces are replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:
Baked_GoodsCloudsEuropean_CitiesFruitsGreek_DeitiesLegendary_Creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_CatsTo obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The stack's default Availability Zone, which must be in the specified region. For more information, see\n Regions and Endpoints.\n If you also specify a value for DefaultSubnetId, the subnet must be in the same zone.\n For more information, see CreateStack.\n
The stack's default subnet ID.\n All instances will be launched into this subnet unless you specify otherwise when you create the instance.\n If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone.\n For more information, see CreateStack.\n
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. \nThe string should be in the following format and must escape characters such as '\"'.:
\n\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
\n " }, "ConfigurationManager": { "shape_name": "StackConfigurationManager", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name. This parameter must be set to \"Chef\".
\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\nThe Chef version. This parameter must be set to \"0.9\" or \"11.4\". The default value is \"0.9\".\n However, we expect to change the default value to \"11.4\" in September 2013.
\n " } }, "documentation": "\nThe configuration manager. When you update a stack you can optionally use the configuration manager to\n specify the Chef version, 0.9 or 11.4. If you omit this parameter, AWS OpsWorks does not change\n the Chef version.\n
\n " }, "UseCustomCookbooks": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": " \nWhether the stack uses custom cookbooks.
\n " }, "CustomCookbooksSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\nThe repository type.
\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\nThe source URL.
" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\nThis parameter depends on the repository type.
\nUsername to the appropriate AWS access key.Username to the user name.This parameter depends on the repository type.
\nPassword to the appropriate AWS secret key.Password to the password.The repository's SSH key.
\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\nThe application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.
\n " } }, "documentation": "\nContains the information required to retrieve an app or cookbook from a repository. For more information, see\n Creating Apps or\n Custom Recipes and Cookbooks.
\n " }, "DefaultSshKeyName": { "shape_name": "String", "type": "string", "documentation": "\nA default SSH key for the stack instances. You can override this value when you create or update an instance.
\n " }, "DefaultRootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\nThe default root device type. This value is used by default for all instances in the cloned stack,\n but you can override it when you create an instance.\n For more information, see Storage for the Root Device.
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nUpdates a specified stack.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "UpdateUserProfile": { "name": "UpdateUserProfile", "input": { "shape_name": "UpdateUserProfileRequest", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\nThe user IAM ARN.
\n ", "required": true }, "SshUsername": { "shape_name": "String", "type": "string", "documentation": "\nThe user's new SSH user name.
\n " }, "SshPublicKey": { "shape_name": "String", "type": "string", "documentation": "\nThe user's new SSH public key.
\n " }, "AllowSelfManagement": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\nWhether users can specify their own SSH public key through the My Settings page. For more information, see\n Managing User Permissions.
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nUpdates a specified user profile.
\nRequired Permissions: To use this action, an IAM user must have an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " }, "UpdateVolume": { "name": "UpdateVolume", "input": { "shape_name": "UpdateVolumeRequest", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe volume ID.
\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe new name.
\n " }, "MountPoint": { "shape_name": "String", "type": "string", "documentation": "\nThe new mount point.
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a request was invalid.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\nThe exception message.
\n " } }, "documentation": "\nIndicates that a resource was not found.
\n " } ], "documentation": "\nUpdates an Amazon EBS volume's name or mount point. For more information, see\n Resource Management.
\nRequired Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.
\n " } }, "metadata": { "regions": { "us-east-1": null }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }