OpsWorks ******** Client ====== class OpsWorks.Client A low-level client representing AWS OpsWorks Welcome to the *OpsWorks Stacks API Reference*. This guide provides descriptions, syntax, and usage examples for OpsWorks Stacks actions and data types, including common parameters and error codes. OpsWorks Stacks is an application management service that provides an integrated experience for managing the complete application lifecycle. For information about OpsWorks, see the OpsWorks information page. **SDKs and CLI** Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the Amazon Web Services SDKs to implement applications in your preferred language. For more information, see: * CLI * SDK for Java * SDK for .NET * SDK for PHP * SDK for Ruby * Amazon Web Services SDK for Node.js * SDK for Python (Boto) **Endpoints** OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created. * opsworks.us-east-1.amazonaws.com * opsworks.us-east-2.amazonaws.com * opsworks.us-west-1.amazonaws.com * opsworks.us-west-2.amazonaws.com * opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console) * opsworks.eu-west-1.amazonaws.com * opsworks.eu-west-2.amazonaws.com * opsworks.eu-west-3.amazonaws.com * opsworks.eu-central-1.amazonaws.com * opsworks.ap-northeast-1.amazonaws.com * opsworks.ap-northeast-2.amazonaws.com * opsworks.ap-south-1.amazonaws.com * opsworks.ap-southeast-1.amazonaws.com * opsworks.ap-southeast-2.amazonaws.com * opsworks.sa-east-1.amazonaws.com **Chef Versions** When you call CreateStack, CloneStack, or UpdateStack we recommend you use the "ConfigurationManager" parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions. Note: You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible. import boto3 client = boto3.client('opsworks') These are the available methods: * assign_instance * assign_volume * associate_elastic_ip * attach_elastic_load_balancer * can_paginate * clone_stack * close * create_app * create_deployment * create_instance * create_layer * create_stack * create_user_profile * delete_app * delete_instance * delete_layer * delete_stack * delete_user_profile * deregister_ecs_cluster * deregister_elastic_ip * deregister_instance * deregister_rds_db_instance * deregister_volume * describe_agent_versions * describe_apps * describe_commands * describe_deployments * describe_ecs_clusters * describe_elastic_ips * describe_elastic_load_balancers * describe_instances * describe_layers * describe_load_based_auto_scaling * describe_my_user_profile * describe_operating_systems * describe_permissions * describe_raid_arrays * describe_rds_db_instances * describe_service_errors * describe_stack_provisioning_parameters * describe_stack_summary * describe_stacks * describe_time_based_auto_scaling * describe_user_profiles * describe_volumes * detach_elastic_load_balancer * disassociate_elastic_ip * get_hostname_suggestion * get_paginator * get_waiter * grant_access * list_tags * reboot_instance * register_ecs_cluster * register_elastic_ip * register_instance * register_rds_db_instance * register_volume * set_load_based_auto_scaling * set_permission * set_time_based_auto_scaling * start_instance * start_stack * stop_instance * stop_stack * tag_resource * unassign_instance * unassign_volume * untag_resource * update_app * update_elastic_ip * update_instance * update_layer * update_my_user_profile * update_rds_db_instance * update_stack * update_user_profile * update_volume Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * DescribeEcsClusters Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * AppExists * DeploymentSuccessful * InstanceOnline * InstanceRegistered * InstanceStopped * InstanceTerminated Resources ========= Resources are available in boto3 via the "resource" method. For more detailed instructions and examples on the usage of resources, see the resources user guide. The available resources are: * Service Resource * Layer * Stack * StackSummary OpsWorks / Resource / StackSummary StackSummary ************ Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class OpsWorks.StackSummary(stack_id) A resource representing an AWS OpsWorks StackSummary: import boto3 opsworks = boto3.resource('opsworks') stack_summary = opsworks.StackSummary('stack_id') Parameters: **stack_id** (*string*) -- The StackSummary's stack_id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * stack_id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * apps_count * arn * instances_count * layers_count * name Sub-resources ============= Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide. These are the resource's available sub-resources: * Stack StackSummary / Attribute / arn arn *** OpsWorks.StackSummary.arn * *(string) --* The stack's ARN. StackSummary / Attribute / name name **** OpsWorks.StackSummary.name * *(string) --* The stack name. StackSummary / Identifier / stack_id stack_id ******** OpsWorks.StackSummary.stack_id *(string)* The StackSummary's stack_id identifier. This **must** be set. StackSummary / Attribute / layers_count layers_count ************ OpsWorks.StackSummary.layers_count * *(integer) --* The number of layers. StackSummary / Attribute / instances_count instances_count *************** OpsWorks.StackSummary.instances_count * *(dict) --* An "InstancesCount" object with the number of instances in each status. * **Assigning** *(integer) --* The number of instances in the Assigning state. * **Booting** *(integer) --* The number of instances with "booting" status. * **ConnectionLost** *(integer) --* The number of instances with "connection_lost" status. * **Deregistering** *(integer) --* The number of instances in the Deregistering state. * **Online** *(integer) --* The number of instances with "online" status. * **Pending** *(integer) --* The number of instances with "pending" status. * **Rebooting** *(integer) --* The number of instances with "rebooting" status. * **Registered** *(integer) --* The number of instances in the Registered state. * **Registering** *(integer) --* The number of instances in the Registering state. * **Requested** *(integer) --* The number of instances with "requested" status. * **RunningSetup** *(integer) --* The number of instances with "running_setup" status. * **SetupFailed** *(integer) --* The number of instances with "setup_failed" status. * **ShuttingDown** *(integer) --* The number of instances with "shutting_down" status. * **StartFailed** *(integer) --* The number of instances with "start_failed" status. * **StopFailed** *(integer) --* The number of instances with "stop_failed" status. * **Stopped** *(integer) --* The number of instances with "stopped" status. * **Stopping** *(integer) --* The number of instances with "stopping" status. * **Terminated** *(integer) --* The number of instances with "terminated" status. * **Terminating** *(integer) --* The number of instances with "terminating" status. * **Unassigning** *(integer) --* The number of instances in the Unassigning state. StackSummary / Attribute / apps_count apps_count ********** OpsWorks.StackSummary.apps_count * *(integer) --* The number of apps. StackSummary / Sub-Resource / Stack Stack ***** OpsWorks.StackSummary.Stack() Creates a Stack resource.: stack = stack_summary.Stack() Return type: "OpsWorks.Stack" Returns: A Stack resource Layer / Attribute / auto_assign_elastic_ips auto_assign_elastic_ips *********************** OpsWorks.Layer.auto_assign_elastic_ips * *(boolean) --* Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer. Layer / Action / get_available_subresources get_available_subresources ************************** OpsWorks.Layer.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str Layer / Attribute / custom_instance_profile_arn custom_instance_profile_arn *************************** OpsWorks.Layer.custom_instance_profile_arn * *(string) --* The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers. Layer / Attribute / default_recipes default_recipes *************** OpsWorks.Layer.default_recipes * *(dict) --* OpsWorks Stacks supports five lifecycle events: **setup**, **configuration**, **deploy**, **undeploy**, and **shutdown**. For each layer, OpsWorks Stacks runs a set of standard recipes for each event. You can also provide custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the standard recipes. "LayerCustomRecipes" specifies the custom recipes for a particular layer to be run in response to each of the five events. To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the ".rb" extension. For example: "phpapp2::dbsetup" specifies the "dbsetup.rb" recipe in the repository's "phpapp2" folder. * **Setup** *(list) --* An array of custom recipe names to be run following a "setup" event. * *(string) --* * **Configure** *(list) --* An array of custom recipe names to be run following a "configure" event. * *(string) --* * **Deploy** *(list) --* An array of custom recipe names to be run following a "deploy" event. * *(string) --* * **Undeploy** *(list) --* An array of custom recipe names to be run following a "undeploy" event. * *(string) --* * **Shutdown** *(list) --* An array of custom recipe names to be run following a "shutdown" event. * *(string) --* Layer / Attribute / lifecycle_event_configuration lifecycle_event_configuration ***************************** OpsWorks.Layer.lifecycle_event_configuration * *(dict) --* A "LifeCycleEventConfiguration" object that specifies the Shutdown event configuration. * **Shutdown** *(dict) --* A "ShutdownEventConfiguration" object that specifies the Shutdown event configuration. * **ExecutionTimeout** *(integer) --* The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before shutting down an instance. * **DelayUntilElbConnectionsDrained** *(boolean) --* Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining Layer / Action / load load **** OpsWorks.Layer.load() Calls "OpsWorks.Client.describe_layers()" to update the attributes of the Layer resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** layer.load() Returns: None OpsWorks / Resource / Layer Layer ***** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class OpsWorks.Layer(id) A resource representing an AWS OpsWorks Layer: import boto3 opsworks = boto3.resource('opsworks') layer = opsworks.Layer('id') Parameters: **id** (*string*) -- The Layer's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * arn * attributes * auto_assign_elastic_ips * auto_assign_public_ips * cloud_watch_logs_configuration * created_at * custom_instance_profile_arn * custom_json * custom_recipes * custom_security_group_ids * default_recipes * default_security_group_names * enable_auto_healing * install_updates_on_boot * layer_id * lifecycle_event_configuration * name * packages * shortname * stack_id * type * use_ebs_optimized_instances * volume_configurations References ========== References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide. These are the resource's available references: * stack Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * delete * get_available_subresources * load * reload Layer / Attribute / type type **** OpsWorks.Layer.type * *(string) --* The layer type. Layer / Attribute / attributes attributes ********** OpsWorks.Layer.attributes * *(dict) --* The layer attributes. For the "HaproxyStatsPassword", "MysqlRootPassword", and "GangliaPassword" attributes, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value For an ECS Cluster layer, OpsWorks Stacks the "EcsClusterArn" attribute is set to the cluster's ARN. * *(string) --* * *(string) --* Layer / Attribute / arn arn *** OpsWorks.Layer.arn * *(string) --* The Amazon Resource Number (ARN) of a layer. Layer / Attribute / layer_id layer_id ******** OpsWorks.Layer.layer_id * *(string) --* The layer ID. Layer / Attribute / created_at created_at ********** OpsWorks.Layer.created_at * *(string) --* Date when the layer was created. Layer / Attribute / use_ebs_optimized_instances use_ebs_optimized_instances *************************** OpsWorks.Layer.use_ebs_optimized_instances * *(boolean) --* Whether the layer uses Amazon EBS-optimized instances. Layer / Attribute / custom_recipes custom_recipes ************** OpsWorks.Layer.custom_recipes * *(dict) --* A "LayerCustomRecipes" object that specifies the layer's custom recipes. * **Setup** *(list) --* An array of custom recipe names to be run following a "setup" event. * *(string) --* * **Configure** *(list) --* An array of custom recipe names to be run following a "configure" event. * *(string) --* * **Deploy** *(list) --* An array of custom recipe names to be run following a "deploy" event. * *(string) --* * **Undeploy** *(list) --* An array of custom recipe names to be run following a "undeploy" event. * *(string) --* * **Shutdown** *(list) --* An array of custom recipe names to be run following a "shutdown" event. * *(string) --* Layer / Attribute / name name **** OpsWorks.Layer.name * *(string) --* The layer name. Layer names can be a maximum of 32 characters. Layer / Attribute / install_updates_on_boot install_updates_on_boot *********************** OpsWorks.Layer.install_updates_on_boot * *(boolean) --* Whether to install operating system and package updates when the instance boots. The default value is "true". If this value is set to "false", you must then update your instances manually by using CreateDeployment to run the "update_dependencies" stack command or manually running "yum" (Amazon Linux) or "apt-get" (Ubuntu) on the instances. Note: We strongly recommend using the default value of "true", to ensure that your instances have the latest security updates. Layer / Attribute / shortname shortname ********* OpsWorks.Layer.shortname * *(string) --* The layer short name. Layer / Attribute / stack_id stack_id ******** OpsWorks.Layer.stack_id * *(string) --* The layer stack ID. Layer / Action / reload reload ****** OpsWorks.Layer.reload() Calls "OpsWorks.Client.describe_layers()" to update the attributes of the Layer resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** layer.reload() Returns: None Layer / Attribute / custom_json custom_json *********** OpsWorks.Layer.custom_json * *(string) --* A JSON formatted string containing the layer's custom stack configuration and deployment attributes. Layer / Attribute / packages packages ******** OpsWorks.Layer.packages * *(list) --* An array of "Package" objects that describe the layer's packages. * *(string) --* Layer / Attribute / cloud_watch_logs_configuration cloud_watch_logs_configuration ****************************** OpsWorks.Layer.cloud_watch_logs_configuration * *(dict) --* The Amazon CloudWatch Logs configuration settings for the layer. * **Enabled** *(boolean) --* Whether CloudWatch Logs is enabled for a layer. * **LogStreams** *(list) --* A list of configuration options for CloudWatch Logs. * *(dict) --* Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference. * **LogGroupName** *(string) --* Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period). * **DatetimeFormat** *(string) --* Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference. * **TimeZone** *(string) --* Specifies the time zone of log event time stamps. * **File** *(string) --* Specifies log files that you want to push to CloudWatch Logs. "File" can point to a specific file or multiple files (by using wild card characters such as "/var/log/system.log*"). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as "access_log.2014-06-01-01", "access_log.2014-06-01-02", and so on by using a pattern like "access_log.*". Don't use a wildcard to match multiple file types, such as "access_log_80" and "access_log_443". To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group. Zipped files are not supported. * **FileFingerprintLines** *(string) --* Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available. * **MultiLineStartPattern** *(string) --* Specifies the pattern for identifying the start of a log message. * **InitialPosition** *(string) --* Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream. * **Encoding** *(string) --* Specifies the encoding of the log file so that the file can be read correctly. The default is "utf_8". Encodings supported by Python "codecs.decode()" can be used here. * **BufferDuration** *(integer) --* Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms. * **BatchCount** *(integer) --* Specifies the max number of log events in a batch, up to 10000. The default value is 1000. * **BatchSize** *(integer) --* Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. Layer / Attribute / auto_assign_public_ips auto_assign_public_ips ********************** OpsWorks.Layer.auto_assign_public_ips * *(boolean) --* For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer. Layer / Identifier / id id ** OpsWorks.Layer.id *(string)* The Layer's id identifier. This **must** be set. Layer / Attribute / enable_auto_healing enable_auto_healing ******************* OpsWorks.Layer.enable_auto_healing * *(boolean) --* Whether auto healing is disabled for the layer. Layer / Reference / stack stack ***** OpsWorks.Layer.stack ("Stack") The related stack if set, otherwise "None". Layer / Attribute / volume_configurations volume_configurations ********************* OpsWorks.Layer.volume_configurations * *(list) --* A "VolumeConfigurations" object that describes the layer's Amazon EBS volumes. * *(dict) --* Describes an Amazon EBS volume configuration. * **MountPoint** *(string) --* The volume mount point. For example "/dev/sdh". * **RaidLevel** *(integer) --* The volume RAID level. * **NumberOfDisks** *(integer) --* The number of disks in the volume. * **Size** *(integer) --* The volume size. * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS Volume Types. * "standard" - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB. * "io1" - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB. * "gp2" - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB. * "st1" - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * "sc1" - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * **Iops** *(integer) --* For PIOPS volumes, the IOPS per disk. * **Encrypted** *(boolean) --* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption. Layer / Attribute / custom_security_group_ids custom_security_group_ids ************************* OpsWorks.Layer.custom_security_group_ids * *(list) --* An array containing the layer's custom security group IDs. * *(string) --* Layer / Action / delete delete ****** OpsWorks.Layer.delete() Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = layer.delete() Returns: None Layer / Attribute / default_security_group_names default_security_group_names **************************** OpsWorks.Layer.default_security_group_names * *(list) --* An array containing the layer's security group names. * *(string) --* OpsWorks / Waiter / InstanceTerminated InstanceTerminated ****************** class OpsWorks.Waiter.InstanceTerminated waiter = client.get_waiter('instance_terminated') wait(**kwargs) Polls "OpsWorks.Client.describe_instances()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( StackId='string', LayerId='string', InstanceIds=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **StackId** (*string*) -- A stack ID. If you use this parameter, "DescribeInstances" returns descriptions of the instances associated with the specified stack. * **LayerId** (*string*) -- A layer ID. If you use this parameter, "DescribeInstances" returns descriptions of the instances associated with the specified layer. * **InstanceIds** (*list*) -- An array of instance IDs to be described. If you use this parameter, "DescribeInstances" returns a description of the specified instances. Otherwise, it returns a description of every instance. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None OpsWorks / Waiter / DeploymentSuccessful DeploymentSuccessful ******************** class OpsWorks.Waiter.DeploymentSuccessful waiter = client.get_waiter('deployment_successful') wait(**kwargs) Polls "OpsWorks.Client.describe_deployments()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( StackId='string', AppId='string', DeploymentIds=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **StackId** (*string*) -- The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack. * **AppId** (*string*) -- The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app. * **DeploymentIds** (*list*) -- An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None OpsWorks / Waiter / InstanceRegistered InstanceRegistered ****************** class OpsWorks.Waiter.InstanceRegistered waiter = client.get_waiter('instance_registered') wait(**kwargs) Polls "OpsWorks.Client.describe_instances()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( StackId='string', LayerId='string', InstanceIds=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **StackId** (*string*) -- A stack ID. If you use this parameter, "DescribeInstances" returns descriptions of the instances associated with the specified stack. * **LayerId** (*string*) -- A layer ID. If you use this parameter, "DescribeInstances" returns descriptions of the instances associated with the specified layer. * **InstanceIds** (*list*) -- An array of instance IDs to be described. If you use this parameter, "DescribeInstances" returns a description of the specified instances. Otherwise, it returns a description of every instance. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None OpsWorks / Waiter / InstanceStopped InstanceStopped *************** class OpsWorks.Waiter.InstanceStopped waiter = client.get_waiter('instance_stopped') wait(**kwargs) Polls "OpsWorks.Client.describe_instances()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( StackId='string', LayerId='string', InstanceIds=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **StackId** (*string*) -- A stack ID. If you use this parameter, "DescribeInstances" returns descriptions of the instances associated with the specified stack. * **LayerId** (*string*) -- A layer ID. If you use this parameter, "DescribeInstances" returns descriptions of the instances associated with the specified layer. * **InstanceIds** (*list*) -- An array of instance IDs to be described. If you use this parameter, "DescribeInstances" returns a description of the specified instances. Otherwise, it returns a description of every instance. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None OpsWorks / Waiter / InstanceOnline InstanceOnline ************** class OpsWorks.Waiter.InstanceOnline waiter = client.get_waiter('instance_online') wait(**kwargs) Polls "OpsWorks.Client.describe_instances()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( StackId='string', LayerId='string', InstanceIds=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **StackId** (*string*) -- A stack ID. If you use this parameter, "DescribeInstances" returns descriptions of the instances associated with the specified stack. * **LayerId** (*string*) -- A layer ID. If you use this parameter, "DescribeInstances" returns descriptions of the instances associated with the specified layer. * **InstanceIds** (*list*) -- An array of instance IDs to be described. If you use this parameter, "DescribeInstances" returns a description of the specified instances. Otherwise, it returns a description of every instance. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None OpsWorks / Waiter / AppExists AppExists ********* class OpsWorks.Waiter.AppExists waiter = client.get_waiter('app_exists') wait(**kwargs) Polls "OpsWorks.Client.describe_apps()" every 1 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( StackId='string', AppIds=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **StackId** (*string*) -- The app stack ID. If you use this parameter, "DescribeApps" returns a description of the apps in the specified stack. * **AppIds** (*list*) -- An array of app IDs for the apps to be described. If you use this parameter, "DescribeApps" returns a description of the specified apps. Otherwise, it returns a description of every app. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 1 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None ServiceResource / Action / get_available_subresources get_available_subresources ************************** OpsWorks.ServiceResource.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str ServiceResource / Action / create_stack create_stack ************ OpsWorks.ServiceResource.create_stack(**kwargs) Creates a new stack. For more information, see Create a New Stack. **Required Permissions**: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** stack = opsworks.create_stack( Name='string', Region='string', VpcId='string', Attributes={ 'string': 'string' }, ServiceRoleArn='string', DefaultInstanceProfileArn='string', DefaultOs='string', HostnameTheme='string', DefaultAvailabilityZone='string', DefaultSubnetId='string', CustomJson='string', ConfigurationManager={ 'Name': 'string', 'Version': 'string' }, ChefConfiguration={ 'ManageBerkshelf': True|False, 'BerkshelfVersion': 'string' }, UseCustomCookbooks=True|False, UseOpsworksSecurityGroups=True|False, CustomCookbooksSource={ 'Type': 'git'|'svn'|'archive'|'s3', 'Url': 'string', 'Username': 'string', 'Password': 'string', 'SshKey': 'string', 'Revision': 'string' }, DefaultSshKeyName='string', DefaultRootDeviceType='ebs'|'instance-store', AgentVersion='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The stack name. Stack names can be a maximum of 64 characters. * **Region** (*string*) -- **[REQUIRED]** The stack's Amazon Web Services Region, such as "ap-south-1". For more information about Amazon Web Services Regions, see Regions and Endpoints. Note: In the CLI, this API maps to the "--stack-region" parameter. If the "--stack-region" parameter and the CLI common parameter "--region" are set to the same value, the stack uses a *regional* endpoint. If the "--stack-region" parameter is not set, but the CLI "--region" parameter is, this also results in a stack with a *regional* endpoint. However, if the "--region" parameter is set to "us-east-1", and the "--stack-region" parameter is set to one of the following, then the stack uses a legacy or *classic* region: "us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2". In this case, the actual API endpoint of the stack is in "us- east-1". Only the preceding regions are supported as classic regions in the "us-east-1" API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage Amazon Web Services, we recommend that you use regional endpoints for new stacks. The CLI common "--region" parameter always specifies a regional API endpoint; it cannot be used to specify a classic OpsWorks Stacks region. * **VpcId** (*string*) -- The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later. * If your account supports EC2-Classic, the default value is "no VPC". * If your account does not support EC2-Classic, the default value is the default VPC for the specified region. If the VPC ID corresponds to a default VPC and you have specified either the "DefaultAvailabilityZone" or the "DefaultSubnetId" parameter only, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. If you specify a nondefault VPC ID, note the following: * It must belong to a VPC in your account that is in the specified region. * You must specify a value for "DefaultSubnetId". For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms. * **Attributes** (*dict*) -- One or more user-defined key-value pairs to be added to the stack attributes. * *(string) --* * *(string) --* * **ServiceRoleArn** (*string*) -- **[REQUIRED]** The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers. * **DefaultInstanceProfileArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. * **DefaultOs** (*string*) -- The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following. * A supported Linux operating system: An Amazon Linux version, such as "Amazon Linux 2", "Amazon Linux 2018.03", "Amazon Linux 2017.09", "Amazon Linux 2017.03", "Amazon Linux 2016.09", "Amazon Linux 2016.03", "Amazon Linux 2015.09", or "Amazon Linux 2015.03". * A supported Ubuntu operating system, such as "Ubuntu 18.04 LTS", "Ubuntu 16.04 LTS", "Ubuntu 14.04 LTS", or "Ubuntu 12.04 LTS". * "CentOS Linux 7" * "Red Hat Enterprise Linux 7" * A supported Windows operating system, such as "Microsoft Windows Server 2012 R2 Base", "Microsoft Windows Server 2012 R2 with SQL Server Express", "Microsoft Windows Server 2012 R2 with SQL Server Standard", or "Microsoft Windows Server 2012 R2 with SQL Server Web". * A custom AMI: "Custom". You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs. The default option is the current Amazon Linux version. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems. * **HostnameTheme** (*string*) -- The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, "HostnameTheme" is set to "Layer_Dependent", which creates host names by appending integers to the layer's short name. The other themes are: * "Baked_Goods" * "Clouds" * "Europe_Cities" * "Fruits" * "Greek_Deities_and_Titans" * "Legendary_creatures_from_Japan" * "Planets_and_Moons" * "Roman_Deities" * "Scottish_Islands" * "US_Cities" * "Wild_Cats" To obtain a generated host name, call "GetHostNameSuggestion", which returns a host name based on the current theme. * **DefaultAvailabilityZone** (*string*) -- The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for "DefaultSubnetId", the subnet must be in the same zone. For more information, see the "VpcId" parameter description. * **DefaultSubnetId** (*string*) -- The stack's default VPC subnet ID. This parameter is required if you specify a value for the "VpcId" parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for "DefaultAvailabilityZone", the subnet must be in that zone. For information on default values and when this parameter is required, see the "VpcId" parameter description. * **CustomJson** (*string*) -- A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format: ""{\"key1\": \"value1\", \"key2\": \"value2\",...}"" For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. * **ConfigurationManager** (*dict*) -- The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. * **Name** *(string) --* The name. This parameter must be set to "Chef". * **Version** *(string) --* The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12. * **ChefConfiguration** (*dict*) -- A "ChefConfiguration" object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack. * **ManageBerkshelf** *(boolean) --* Whether to enable Berkshelf. * **BerkshelfVersion** *(string) --* The Berkshelf version. * **UseCustomCookbooks** (*boolean*) -- Whether the stack uses custom cookbooks. * **UseOpsworksSecurityGroups** (*boolean*) -- Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers. OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With "UseOpsworksSecurityGroups" you can instead provide your own custom security groups. "UseOpsworksSecurityGroups" has the following settings: * True - OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. * False - OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. For more information, see Create a New Stack. * **CustomCookbooksSource** (*dict*) -- Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes. * **Type** *(string) --* The repository type. * **Url** *(string) --* The source URL. The following is an example of an Amazon S3 source URL: "https://s3.amazonaws.com/opsworks-demo- bucket/opsworks_cookbook_demo.tar.gz". * **Username** *(string) --* This parameter depends on the repository type. * For Amazon S3 bundles, set "Username" to the appropriate IAM access key ID. * For HTTP bundles, Git repositories, and Subversion repositories, set "Username" to the user name. * **Password** *(string) --* When included in a request, the parameter depends on the repository type. * For Amazon S3 bundles, set "Password" to the appropriate IAM secret access key. * For HTTP bundles and Subversion repositories, set "Password" to the password. For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access- keys-best-practices.html. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **SshKey** *(string) --* In requests, the repository's SSH key. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **Revision** *(string) --* The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. * **DefaultSshKeyName** (*string*) -- A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance. * **DefaultRootDeviceType** (*string*) -- The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is "instance-store". For more information, see Storage for the Root Device. * **AgentVersion** (*string*) -- The default OpsWorks Stacks agent version. You have the following options: * Auto-update - Set this parameter to "LATEST". OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. * Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. OpsWorks Stacks installs that version on the stack's instances. The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. Note: You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. Return type: "opsworks.Stack" Returns: Stack resource ServiceResource / Sub-Resource / StackSummary StackSummary ************ OpsWorks.ServiceResource.StackSummary(stack_id) Creates a StackSummary resource.: stack_summary = opsworks.StackSummary('stack_id') Parameters: **stack_id** (*string*) -- The StackSummary's stack_id identifier. This **must** be set. Return type: "OpsWorks.StackSummary" Returns: A StackSummary resource ServiceResource / Collection / stacks stacks ****** OpsWorks.ServiceResource.stacks A collection of Stack resources.A Stack Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Stack resources in the collection. See also: AWS API Documentation **Request Syntax** stack_iterator = opsworks.stacks.all() Return type: list("opsworks.Stack") Returns: A list of Stack resources filter(**kwargs) Creates an iterable of all Stack resources in the collection filtered by kwargs passed to method. A Stack collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** stack_iterator = opsworks.stacks.filter( StackIds=[ 'string', ] ) Parameters: **StackIds** (*list*) -- An array of stack IDs that specify the stacks to be described. If you omit this parameter, and have permissions to get information about all stacks, "DescribeStacks" returns a description of every stack. If the IAM policy that is attached to an IAM user limits the "DescribeStacks" action to specific stack ARNs, this parameter is required, and the user must specify a stack ARN that is allowed by the policy. Otherwise, "DescribeStacks" returns an "AccessDenied" error. * *(string) --* Return type: list("opsworks.Stack") Returns: A list of Stack resources limit(**kwargs) Creates an iterable up to a specified amount of Stack resources in the collection. See also: AWS API Documentation **Request Syntax** stack_iterator = opsworks.stacks.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("opsworks.Stack") Returns: A list of Stack resources page_size(**kwargs) Creates an iterable of all Stack resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** stack_iterator = opsworks.stacks.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("opsworks.Stack") Returns: A list of Stack resources OpsWorks / Resource / ServiceResource Service Resource **************** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class OpsWorks.ServiceResource A resource representing AWS OpsWorks: import boto3 opsworks = boto3.resource('opsworks') Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * create_stack * get_available_subresources Sub-resources ============= Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide. These are the resource's available sub-resources: * Layer * Stack * StackSummary Collections =========== Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide. These are the resource's available collections: * stacks ServiceResource / Sub-Resource / Layer Layer ***** OpsWorks.ServiceResource.Layer(id) Creates a Layer resource.: layer = opsworks.Layer('id') Parameters: **id** (*string*) -- The Layer's id identifier. This **must** be set. Return type: "OpsWorks.Layer" Returns: A Layer resource ServiceResource / Sub-Resource / Stack Stack ***** OpsWorks.ServiceResource.Stack(id) Creates a Stack resource.: stack = opsworks.Stack('id') Parameters: **id** (*string*) -- The Stack's id identifier. This **must** be set. Return type: "OpsWorks.Stack" Returns: A Stack resource Stack / Action / create_layer create_layer ************ OpsWorks.Stack.create_layer(**kwargs) Creates a layer. For more information, see How to Create a Layer. Note: You should use **CreateLayer** for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, **CreateLayer** fails. A stack can have an arbitrary number of custom layers, so you can call **CreateLayer** as many times as you like for that layer type. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** layer = stack.create_layer( Type='aws-flow-ruby'|'ecs-cluster'|'java-app'|'lb'|'web'|'php-app'|'rails-app'|'nodejs-app'|'memcached'|'db-master'|'monitoring-master'|'custom', Name='string', Shortname='string', Attributes={ 'string': 'string' }, CloudWatchLogsConfiguration={ 'Enabled': True|False, 'LogStreams': [ { 'LogGroupName': 'string', 'DatetimeFormat': 'string', 'TimeZone': 'LOCAL'|'UTC', 'File': 'string', 'FileFingerprintLines': 'string', 'MultiLineStartPattern': 'string', 'InitialPosition': 'start_of_file'|'end_of_file', 'Encoding': 'ascii'|'big5'|'big5hkscs'|'cp037'|'cp424'|'cp437'|'cp500'|'cp720'|'cp737'|'cp775'|'cp850'|'cp852'|'cp855'|'cp856'|'cp857'|'cp858'|'cp860'|'cp861'|'cp862'|'cp863'|'cp864'|'cp865'|'cp866'|'cp869'|'cp874'|'cp875'|'cp932'|'cp949'|'cp950'|'cp1006'|'cp1026'|'cp1140'|'cp1250'|'cp1251'|'cp1252'|'cp1253'|'cp1254'|'cp1255'|'cp1256'|'cp1257'|'cp1258'|'euc_jp'|'euc_jis_2004'|'euc_jisx0213'|'euc_kr'|'gb2312'|'gbk'|'gb18030'|'hz'|'iso2022_jp'|'iso2022_jp_1'|'iso2022_jp_2'|'iso2022_jp_2004'|'iso2022_jp_3'|'iso2022_jp_ext'|'iso2022_kr'|'latin_1'|'iso8859_2'|'iso8859_3'|'iso8859_4'|'iso8859_5'|'iso8859_6'|'iso8859_7'|'iso8859_8'|'iso8859_9'|'iso8859_10'|'iso8859_13'|'iso8859_14'|'iso8859_15'|'iso8859_16'|'johab'|'koi8_r'|'koi8_u'|'mac_cyrillic'|'mac_greek'|'mac_iceland'|'mac_latin2'|'mac_roman'|'mac_turkish'|'ptcp154'|'shift_jis'|'shift_jis_2004'|'shift_jisx0213'|'utf_32'|'utf_32_be'|'utf_32_le'|'utf_16'|'utf_16_be'|'utf_16_le'|'utf_7'|'utf_8'|'utf_8_sig', 'BufferDuration': 123, 'BatchCount': 123, 'BatchSize': 123 }, ] }, CustomInstanceProfileArn='string', CustomJson='string', CustomSecurityGroupIds=[ 'string', ], Packages=[ 'string', ], VolumeConfigurations=[ { 'MountPoint': 'string', 'RaidLevel': 123, 'NumberOfDisks': 123, 'Size': 123, 'VolumeType': 'string', 'Iops': 123, 'Encrypted': True|False }, ], EnableAutoHealing=True|False, AutoAssignElasticIps=True|False, AutoAssignPublicIps=True|False, CustomRecipes={ 'Setup': [ 'string', ], 'Configure': [ 'string', ], 'Deploy': [ 'string', ], 'Undeploy': [ 'string', ], 'Shutdown': [ 'string', ] }, InstallUpdatesOnBoot=True|False, UseEbsOptimizedInstances=True|False, LifecycleEventConfiguration={ 'Shutdown': { 'ExecutionTimeout': 123, 'DelayUntilElbConnectionsDrained': True|False } } ) Parameters: * **Type** (*string*) -- **[REQUIRED]** The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks. * **Name** (*string*) -- **[REQUIRED]** The layer name, which is used by the console. Layer names can be a maximum of 32 characters. * **Shortname** (*string*) -- **[REQUIRED]** For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric characters, '-', '_', and '.'. Built-in layer short names are defined by OpsWorks Stacks. For more information, see the Layer Reference. * **Attributes** (*dict*) -- One or more user-defined key-value pairs to be added to the stack attributes. To create a cluster layer, set the "EcsClusterArn" attribute to the cluster's ARN. * *(string) --* * *(string) --* * **CloudWatchLogsConfiguration** (*dict*) -- Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream. * **Enabled** *(boolean) --* Whether CloudWatch Logs is enabled for a layer. * **LogStreams** *(list) --* A list of configuration options for CloudWatch Logs. * *(dict) --* Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference. * **LogGroupName** *(string) --* Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period). * **DatetimeFormat** *(string) --* Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference. * **TimeZone** *(string) --* Specifies the time zone of log event time stamps. * **File** *(string) --* Specifies log files that you want to push to CloudWatch Logs. "File" can point to a specific file or multiple files (by using wild card characters such as "/var/log/system.log*"). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as "access_log.2014-06-01-01", "access_log.2014-06-01-02", and so on by using a pattern like "access_log.*". Don't use a wildcard to match multiple file types, such as "access_log_80" and "access_log_443". To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group. Zipped files are not supported. * **FileFingerprintLines** *(string) --* Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available. * **MultiLineStartPattern** *(string) --* Specifies the pattern for identifying the start of a log message. * **InitialPosition** *(string) --* Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream. * **Encoding** *(string) --* Specifies the encoding of the log file so that the file can be read correctly. The default is "utf_8". Encodings supported by Python "codecs.decode()" can be used here. * **BufferDuration** *(integer) --* Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms. * **BatchCount** *(integer) --* Specifies the max number of log events in a batch, up to 10000. The default value is 1000. * **BatchSize** *(integer) --* Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. * **CustomInstanceProfileArn** (*string*) -- The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers. * **CustomJson** (*string*) -- A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the CLI. * **CustomSecurityGroupIds** (*list*) -- An array containing the layer custom security group IDs. * *(string) --* * **Packages** (*list*) -- An array of "Package" objects that describes the layer packages. * *(string) --* * **VolumeConfigurations** (*list*) -- A "VolumeConfigurations" object that describes the layer's Amazon EBS volumes. * *(dict) --* Describes an Amazon EBS volume configuration. * **MountPoint** *(string) --* **[REQUIRED]** The volume mount point. For example "/dev/sdh". * **RaidLevel** *(integer) --* The volume RAID level. * **NumberOfDisks** *(integer) --* **[REQUIRED]** The number of disks in the volume. * **Size** *(integer) --* **[REQUIRED]** The volume size. * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS Volume Types. * "standard" - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB. * "io1" - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB. * "gp2" - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB. * "st1" - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * "sc1" - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * **Iops** *(integer) --* For PIOPS volumes, the IOPS per disk. * **Encrypted** *(boolean) --* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption. * **EnableAutoHealing** (*boolean*) -- Whether to disable auto healing for the layer. * **AutoAssignElasticIps** (*boolean*) -- Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer. * **AutoAssignPublicIps** (*boolean*) -- For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer. * **CustomRecipes** (*dict*) -- A "LayerCustomRecipes" object that specifies the layer custom recipes. * **Setup** *(list) --* An array of custom recipe names to be run following a "setup" event. * *(string) --* * **Configure** *(list) --* An array of custom recipe names to be run following a "configure" event. * *(string) --* * **Deploy** *(list) --* An array of custom recipe names to be run following a "deploy" event. * *(string) --* * **Undeploy** *(list) --* An array of custom recipe names to be run following a "undeploy" event. * *(string) --* * **Shutdown** *(list) --* An array of custom recipe names to be run following a "shutdown" event. * *(string) --* * **InstallUpdatesOnBoot** (*boolean*) -- Whether to install operating system and package updates when the instance boots. The default value is "true". To control when updates are installed, set this value to "false". You must then update your instances manually by using CreateDeployment to run the "update_dependencies" stack command or by manually running "yum" (Amazon Linux) or "apt- get" (Ubuntu) on the instances. Note: To ensure that your instances have the latest security updates, we strongly recommend using the default value of "true". * **UseEbsOptimizedInstances** (*boolean*) -- Whether to use Amazon EBS-optimized instances. * **LifecycleEventConfiguration** (*dict*) -- A "LifeCycleEventConfiguration" object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining. * **Shutdown** *(dict) --* A "ShutdownEventConfiguration" object that specifies the Shutdown event configuration. * **ExecutionTimeout** *(integer) --* The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before shutting down an instance. * **DelayUntilElbConnectionsDrained** *(boolean) --* Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining Return type: "opsworks.Layer" Returns: Layer resource Stack / Action / get_available_subresources get_available_subresources ************************** OpsWorks.Stack.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str Stack / Attribute / chef_configuration chef_configuration ****************** OpsWorks.Stack.chef_configuration * *(dict) --* A "ChefConfiguration" object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack. * **ManageBerkshelf** *(boolean) --* Whether to enable Berkshelf. * **BerkshelfVersion** *(string) --* The Berkshelf version. Stack / Collection / layers layers ****** OpsWorks.Stack.layers A collection of Layer resources.A Layer Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Layer resources in the collection. See also: AWS API Documentation **Request Syntax** layer_iterator = stack.layers.all() Return type: list("opsworks.Layer") Returns: A list of Layer resources filter(**kwargs) Creates an iterable of all Layer resources in the collection filtered by kwargs passed to method. A Layer collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** layer_iterator = stack.layers.filter( LayerIds=[ 'string', ] ) Parameters: **LayerIds** (*list*) -- An array of layer IDs that specify the layers to be described. If you omit this parameter, "DescribeLayers" returns a description of every layer in the specified stack. * *(string) --* Return type: list("opsworks.Layer") Returns: A list of Layer resources limit(**kwargs) Creates an iterable up to a specified amount of Layer resources in the collection. See also: AWS API Documentation **Request Syntax** layer_iterator = stack.layers.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("opsworks.Layer") Returns: A list of Layer resources page_size(**kwargs) Creates an iterable of all Layer resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** layer_iterator = stack.layers.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("opsworks.Layer") Returns: A list of Layer resources Stack / Action / load load **** OpsWorks.Stack.load() Calls "OpsWorks.Client.describe_stacks()" to update the attributes of the Stack resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** stack.load() Returns: None Stack / Attribute / region region ****** OpsWorks.Stack.region * *(string) --* The stack Amazon Web Services Region, such as "ap-northeast-2". For more information about Amazon Web Services Regions, see Regions and Endpoints. OpsWorks / Resource / Stack Stack ***** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class OpsWorks.Stack(id) A resource representing an AWS OpsWorks Stack: import boto3 opsworks = boto3.resource('opsworks') stack = opsworks.Stack('id') Parameters: **id** (*string*) -- The Stack's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * agent_version * arn * attributes * chef_configuration * configuration_manager * created_at * custom_cookbooks_source * custom_json * default_availability_zone * default_instance_profile_arn * default_os * default_root_device_type * default_ssh_key_name * default_subnet_id * hostname_theme * name * region * service_role_arn * stack_id * use_custom_cookbooks * use_opsworks_security_groups * vpc_id Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * create_layer * delete * get_available_subresources * load * reload Sub-resources ============= Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide. These are the resource's available sub-resources: * Summary Collections =========== Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide. These are the resource's available collections: * layers Stack / Attribute / attributes attributes ********** OpsWorks.Stack.attributes * *(dict) --* The stack's attributes. * *(string) --* * *(string) --* Stack / Attribute / arn arn *** OpsWorks.Stack.arn * *(string) --* The stack's ARN. Stack / Attribute / default_root_device_type default_root_device_type ************************ OpsWorks.Stack.default_root_device_type * *(string) --* The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device. Stack / Attribute / created_at created_at ********** OpsWorks.Stack.created_at * *(string) --* The date when the stack was created. Stack / Attribute / custom_cookbooks_source custom_cookbooks_source *********************** OpsWorks.Stack.custom_cookbooks_source * *(dict) --* Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes. * **Type** *(string) --* The repository type. * **Url** *(string) --* The source URL. The following is an example of an Amazon S3 source URL: "https://s3.amazonaws.com/opsworks-demo- bucket/opsworks_cookbook_demo.tar.gz". * **Username** *(string) --* This parameter depends on the repository type. * For Amazon S3 bundles, set "Username" to the appropriate IAM access key ID. * For HTTP bundles, Git repositories, and Subversion repositories, set "Username" to the user name. * **Password** *(string) --* When included in a request, the parameter depends on the repository type. * For Amazon S3 bundles, set "Password" to the appropriate IAM secret access key. * For HTTP bundles and Subversion repositories, set "Password" to the password. For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access- keys-best-practices.html. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **SshKey** *(string) --* In requests, the repository's SSH key. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **Revision** *(string) --* The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. Stack / Attribute / default_ssh_key_name default_ssh_key_name ******************** OpsWorks.Stack.default_ssh_key_name * *(string) --* A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance. Stack / Attribute / agent_version agent_version ************* OpsWorks.Stack.agent_version * *(string) --* The agent version. This parameter is set to "LATEST" for auto- update. or a version number for a fixed agent version. Stack / Attribute / name name **** OpsWorks.Stack.name * *(string) --* The stack name. Stack names can be a maximum of 64 characters. Stack / Sub-Resource / Summary Summary ******* OpsWorks.Stack.Summary() Creates a StackSummary resource.: stack_summary = stack.Summary() Return type: "OpsWorks.StackSummary" Returns: A StackSummary resource Stack / Attribute / configuration_manager configuration_manager ********************* OpsWorks.Stack.configuration_manager * *(dict) --* The configuration manager. * **Name** *(string) --* The name. This parameter must be set to "Chef". * **Version** *(string) --* The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12. Stack / Attribute / stack_id stack_id ******** OpsWorks.Stack.stack_id * *(string) --* The stack ID. Stack / Action / reload reload ****** OpsWorks.Stack.reload() Calls "OpsWorks.Client.describe_stacks()" to update the attributes of the Stack resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** stack.reload() Returns: None Stack / Attribute / custom_json custom_json *********** OpsWorks.Stack.custom_json * *(string) --* A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format: ""{\"key1\": \"value1\", \"key2\": \"value2\",...}"" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. Stack / Attribute / default_os default_os ********** OpsWorks.Stack.default_os * *(string) --* The stack's default operating system. Stack / Attribute / default_subnet_id default_subnet_id ***************** OpsWorks.Stack.default_subnet_id * *(string) --* The default subnet ID; applicable only if the stack is running in a VPC. Stack / Attribute / service_role_arn service_role_arn **************** OpsWorks.Stack.service_role_arn * *(string) --* The stack Identity and Access Management (IAM) role. Stack / Attribute / use_opsworks_security_groups use_opsworks_security_groups **************************** OpsWorks.Stack.use_opsworks_security_groups * *(boolean) --* Whether the stack automatically associates the OpsWorks Stacks built-in security groups with the stack's layers. Stack / Attribute / vpc_id vpc_id ****** OpsWorks.Stack.vpc_id * *(string) --* The VPC ID; applicable only if the stack is running in a VPC. Stack / Attribute / default_availability_zone default_availability_zone ************************* OpsWorks.Stack.default_availability_zone * *(string) --* The stack's default Availability Zone. For more information, see Regions and Endpoints. Stack / Attribute / hostname_theme hostname_theme ************** OpsWorks.Stack.hostname_theme * *(string) --* The stack host name theme, with spaces replaced by underscores. Stack / Identifier / id id ** OpsWorks.Stack.id *(string)* The Stack's id identifier. This **must** be set. Stack / Attribute / use_custom_cookbooks use_custom_cookbooks ******************** OpsWorks.Stack.use_custom_cookbooks * *(boolean) --* Whether the stack uses custom cookbooks. Stack / Attribute / default_instance_profile_arn default_instance_profile_arn **************************** OpsWorks.Stack.default_instance_profile_arn * *(string) --* The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. Stack / Action / delete delete ****** OpsWorks.Stack.delete() Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = stack.delete() Returns: None OpsWorks / Paginator / DescribeEcsClusters DescribeEcsClusters ******************* class OpsWorks.Paginator.DescribeEcsClusters paginator = client.get_paginator('describe_ecs_clusters') paginate(**kwargs) Creates an iterator that will paginate through responses from "OpsWorks.Client.describe_ecs_clusters()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( EcsClusterArns=[ 'string', ], StackId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **EcsClusterArns** (*list*) -- A list of ARNs, one for each cluster to be described. * *(string) --* * **StackId** (*string*) -- A stack ID. "DescribeEcsClusters" returns a description of the cluster that is registered with the stack. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'EcsClusters': [ { 'EcsClusterArn': 'string', 'EcsClusterName': 'string', 'StackId': 'string', 'RegisteredAt': 'string' }, ], } **Response Structure** * *(dict) --* Contains the response to a "DescribeEcsClusters" request. * **EcsClusters** *(list) --* A list of "EcsCluster" objects containing the cluster descriptions. * *(dict) --* Describes a registered Amazon ECS cluster. * **EcsClusterArn** *(string) --* The cluster's ARN. * **EcsClusterName** *(string) --* The cluster name. * **StackId** *(string) --* The stack ID. * **RegisteredAt** *(string) --* The time and date that the cluster was registered with the stack. OpsWorks / Client / create_layer create_layer ************ OpsWorks.Client.create_layer(**kwargs) Creates a layer. For more information, see How to Create a Layer. Note: You should use **CreateLayer** for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, **CreateLayer** fails. A stack can have an arbitrary number of custom layers, so you can call **CreateLayer** as many times as you like for that layer type. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.create_layer( StackId='string', Type='aws-flow-ruby'|'ecs-cluster'|'java-app'|'lb'|'web'|'php-app'|'rails-app'|'nodejs-app'|'memcached'|'db-master'|'monitoring-master'|'custom', Name='string', Shortname='string', Attributes={ 'string': 'string' }, CloudWatchLogsConfiguration={ 'Enabled': True|False, 'LogStreams': [ { 'LogGroupName': 'string', 'DatetimeFormat': 'string', 'TimeZone': 'LOCAL'|'UTC', 'File': 'string', 'FileFingerprintLines': 'string', 'MultiLineStartPattern': 'string', 'InitialPosition': 'start_of_file'|'end_of_file', 'Encoding': 'ascii'|'big5'|'big5hkscs'|'cp037'|'cp424'|'cp437'|'cp500'|'cp720'|'cp737'|'cp775'|'cp850'|'cp852'|'cp855'|'cp856'|'cp857'|'cp858'|'cp860'|'cp861'|'cp862'|'cp863'|'cp864'|'cp865'|'cp866'|'cp869'|'cp874'|'cp875'|'cp932'|'cp949'|'cp950'|'cp1006'|'cp1026'|'cp1140'|'cp1250'|'cp1251'|'cp1252'|'cp1253'|'cp1254'|'cp1255'|'cp1256'|'cp1257'|'cp1258'|'euc_jp'|'euc_jis_2004'|'euc_jisx0213'|'euc_kr'|'gb2312'|'gbk'|'gb18030'|'hz'|'iso2022_jp'|'iso2022_jp_1'|'iso2022_jp_2'|'iso2022_jp_2004'|'iso2022_jp_3'|'iso2022_jp_ext'|'iso2022_kr'|'latin_1'|'iso8859_2'|'iso8859_3'|'iso8859_4'|'iso8859_5'|'iso8859_6'|'iso8859_7'|'iso8859_8'|'iso8859_9'|'iso8859_10'|'iso8859_13'|'iso8859_14'|'iso8859_15'|'iso8859_16'|'johab'|'koi8_r'|'koi8_u'|'mac_cyrillic'|'mac_greek'|'mac_iceland'|'mac_latin2'|'mac_roman'|'mac_turkish'|'ptcp154'|'shift_jis'|'shift_jis_2004'|'shift_jisx0213'|'utf_32'|'utf_32_be'|'utf_32_le'|'utf_16'|'utf_16_be'|'utf_16_le'|'utf_7'|'utf_8'|'utf_8_sig', 'BufferDuration': 123, 'BatchCount': 123, 'BatchSize': 123 }, ] }, CustomInstanceProfileArn='string', CustomJson='string', CustomSecurityGroupIds=[ 'string', ], Packages=[ 'string', ], VolumeConfigurations=[ { 'MountPoint': 'string', 'RaidLevel': 123, 'NumberOfDisks': 123, 'Size': 123, 'VolumeType': 'string', 'Iops': 123, 'Encrypted': True|False }, ], EnableAutoHealing=True|False, AutoAssignElasticIps=True|False, AutoAssignPublicIps=True|False, CustomRecipes={ 'Setup': [ 'string', ], 'Configure': [ 'string', ], 'Deploy': [ 'string', ], 'Undeploy': [ 'string', ], 'Shutdown': [ 'string', ] }, InstallUpdatesOnBoot=True|False, UseEbsOptimizedInstances=True|False, LifecycleEventConfiguration={ 'Shutdown': { 'ExecutionTimeout': 123, 'DelayUntilElbConnectionsDrained': True|False } } ) Parameters: * **StackId** (*string*) -- **[REQUIRED]** The layer stack ID. * **Type** (*string*) -- **[REQUIRED]** The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks. * **Name** (*string*) -- **[REQUIRED]** The layer name, which is used by the console. Layer names can be a maximum of 32 characters. * **Shortname** (*string*) -- **[REQUIRED]** For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric characters, '-', '_', and '.'. Built-in layer short names are defined by OpsWorks Stacks. For more information, see the Layer Reference. * **Attributes** (*dict*) -- One or more user-defined key-value pairs to be added to the stack attributes. To create a cluster layer, set the "EcsClusterArn" attribute to the cluster's ARN. * *(string) --* * *(string) --* * **CloudWatchLogsConfiguration** (*dict*) -- Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream. * **Enabled** *(boolean) --* Whether CloudWatch Logs is enabled for a layer. * **LogStreams** *(list) --* A list of configuration options for CloudWatch Logs. * *(dict) --* Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference. * **LogGroupName** *(string) --* Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period). * **DatetimeFormat** *(string) --* Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference. * **TimeZone** *(string) --* Specifies the time zone of log event time stamps. * **File** *(string) --* Specifies log files that you want to push to CloudWatch Logs. "File" can point to a specific file or multiple files (by using wild card characters such as "/var/log/system.log*"). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as "access_log.2014-06-01-01", "access_log.2014-06-01-02", and so on by using a pattern like "access_log.*". Don't use a wildcard to match multiple file types, such as "access_log_80" and "access_log_443". To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group. Zipped files are not supported. * **FileFingerprintLines** *(string) --* Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available. * **MultiLineStartPattern** *(string) --* Specifies the pattern for identifying the start of a log message. * **InitialPosition** *(string) --* Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream. * **Encoding** *(string) --* Specifies the encoding of the log file so that the file can be read correctly. The default is "utf_8". Encodings supported by Python "codecs.decode()" can be used here. * **BufferDuration** *(integer) --* Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms. * **BatchCount** *(integer) --* Specifies the max number of log events in a batch, up to 10000. The default value is 1000. * **BatchSize** *(integer) --* Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. * **CustomInstanceProfileArn** (*string*) -- The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers. * **CustomJson** (*string*) -- A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the CLI. * **CustomSecurityGroupIds** (*list*) -- An array containing the layer custom security group IDs. * *(string) --* * **Packages** (*list*) -- An array of "Package" objects that describes the layer packages. * *(string) --* * **VolumeConfigurations** (*list*) -- A "VolumeConfigurations" object that describes the layer's Amazon EBS volumes. * *(dict) --* Describes an Amazon EBS volume configuration. * **MountPoint** *(string) --* **[REQUIRED]** The volume mount point. For example "/dev/sdh". * **RaidLevel** *(integer) --* The volume RAID level. * **NumberOfDisks** *(integer) --* **[REQUIRED]** The number of disks in the volume. * **Size** *(integer) --* **[REQUIRED]** The volume size. * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS Volume Types. * "standard" - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB. * "io1" - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB. * "gp2" - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB. * "st1" - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * "sc1" - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * **Iops** *(integer) --* For PIOPS volumes, the IOPS per disk. * **Encrypted** *(boolean) --* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption. * **EnableAutoHealing** (*boolean*) -- Whether to disable auto healing for the layer. * **AutoAssignElasticIps** (*boolean*) -- Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer. * **AutoAssignPublicIps** (*boolean*) -- For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer. * **CustomRecipes** (*dict*) -- A "LayerCustomRecipes" object that specifies the layer custom recipes. * **Setup** *(list) --* An array of custom recipe names to be run following a "setup" event. * *(string) --* * **Configure** *(list) --* An array of custom recipe names to be run following a "configure" event. * *(string) --* * **Deploy** *(list) --* An array of custom recipe names to be run following a "deploy" event. * *(string) --* * **Undeploy** *(list) --* An array of custom recipe names to be run following a "undeploy" event. * *(string) --* * **Shutdown** *(list) --* An array of custom recipe names to be run following a "shutdown" event. * *(string) --* * **InstallUpdatesOnBoot** (*boolean*) -- Whether to install operating system and package updates when the instance boots. The default value is "true". To control when updates are installed, set this value to "false". You must then update your instances manually by using CreateDeployment to run the "update_dependencies" stack command or by manually running "yum" (Amazon Linux) or "apt- get" (Ubuntu) on the instances. Note: To ensure that your instances have the latest security updates, we strongly recommend using the default value of "true". * **UseEbsOptimizedInstances** (*boolean*) -- Whether to use Amazon EBS-optimized instances. * **LifecycleEventConfiguration** (*dict*) -- A "LifeCycleEventConfiguration" object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining. * **Shutdown** *(dict) --* A "ShutdownEventConfiguration" object that specifies the Shutdown event configuration. * **ExecutionTimeout** *(integer) --* The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before shutting down an instance. * **DelayUntilElbConnectionsDrained** *(boolean) --* Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining Return type: dict Returns: **Response Syntax** { 'LayerId': 'string' } **Response Structure** * *(dict) --* Contains the response to a "CreateLayer" request. * **LayerId** *(string) --* The layer ID. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / register_elastic_ip register_elastic_ip ******************* OpsWorks.Client.register_elastic_ip(**kwargs) Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.register_elastic_ip( ElasticIp='string', StackId='string' ) Parameters: * **ElasticIp** (*string*) -- **[REQUIRED]** The Elastic IP address. * **StackId** (*string*) -- **[REQUIRED]** The stack ID. Return type: dict Returns: **Response Syntax** { 'ElasticIp': 'string' } **Response Structure** * *(dict) --* Contains the response to a "RegisterElasticIp" request. * **ElasticIp** *(string) --* The Elastic IP address. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_stacks describe_stacks *************** OpsWorks.Client.describe_stacks(**kwargs) Requests a description of one or more stacks. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_stacks( StackIds=[ 'string', ] ) Parameters: **StackIds** (*list*) -- An array of stack IDs that specify the stacks to be described. If you omit this parameter, and have permissions to get information about all stacks, "DescribeStacks" returns a description of every stack. If the IAM policy that is attached to an IAM user limits the "DescribeStacks" action to specific stack ARNs, this parameter is required, and the user must specify a stack ARN that is allowed by the policy. Otherwise, "DescribeStacks" returns an "AccessDenied" error. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Stacks': [ { 'StackId': 'string', 'Name': 'string', 'Arn': 'string', 'Region': 'string', 'VpcId': 'string', 'Attributes': { 'string': 'string' }, 'ServiceRoleArn': 'string', 'DefaultInstanceProfileArn': 'string', 'DefaultOs': 'string', 'HostnameTheme': 'string', 'DefaultAvailabilityZone': 'string', 'DefaultSubnetId': 'string', 'CustomJson': 'string', 'ConfigurationManager': { 'Name': 'string', 'Version': 'string' }, 'ChefConfiguration': { 'ManageBerkshelf': True|False, 'BerkshelfVersion': 'string' }, 'UseCustomCookbooks': True|False, 'UseOpsworksSecurityGroups': True|False, 'CustomCookbooksSource': { 'Type': 'git'|'svn'|'archive'|'s3', 'Url': 'string', 'Username': 'string', 'Password': 'string', 'SshKey': 'string', 'Revision': 'string' }, 'DefaultSshKeyName': 'string', 'CreatedAt': 'string', 'DefaultRootDeviceType': 'ebs'|'instance-store', 'AgentVersion': 'string' }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeStacks" request. * **Stacks** *(list) --* An array of "Stack" objects that describe the stacks. * *(dict) --* Describes a stack. * **StackId** *(string) --* The stack ID. * **Name** *(string) --* The stack name. Stack names can be a maximum of 64 characters. * **Arn** *(string) --* The stack's ARN. * **Region** *(string) --* The stack Amazon Web Services Region, such as "ap- northeast-2". For more information about Amazon Web Services Regions, see Regions and Endpoints. * **VpcId** *(string) --* The VPC ID; applicable only if the stack is running in a VPC. * **Attributes** *(dict) --* The stack's attributes. * *(string) --* * *(string) --* * **ServiceRoleArn** *(string) --* The stack Identity and Access Management (IAM) role. * **DefaultInstanceProfileArn** *(string) --* The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. * **DefaultOs** *(string) --* The stack's default operating system. * **HostnameTheme** *(string) --* The stack host name theme, with spaces replaced by underscores. * **DefaultAvailabilityZone** *(string) --* The stack's default Availability Zone. For more information, see Regions and Endpoints. * **DefaultSubnetId** *(string) --* The default subnet ID; applicable only if the stack is running in a VPC. * **CustomJson** *(string) --* A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format: ""{\"key1\": \"value1\", \"key2\": \"value2\",...}"" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. * **ConfigurationManager** *(dict) --* The configuration manager. * **Name** *(string) --* The name. This parameter must be set to "Chef". * **Version** *(string) --* The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12. * **ChefConfiguration** *(dict) --* A "ChefConfiguration" object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack. * **ManageBerkshelf** *(boolean) --* Whether to enable Berkshelf. * **BerkshelfVersion** *(string) --* The Berkshelf version. * **UseCustomCookbooks** *(boolean) --* Whether the stack uses custom cookbooks. * **UseOpsworksSecurityGroups** *(boolean) --* Whether the stack automatically associates the OpsWorks Stacks built-in security groups with the stack's layers. * **CustomCookbooksSource** *(dict) --* Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes. * **Type** *(string) --* The repository type. * **Url** *(string) --* The source URL. The following is an example of an Amazon S3 source URL: "https://s3.amazonaws.com /opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz". * **Username** *(string) --* This parameter depends on the repository type. * For Amazon S3 bundles, set "Username" to the appropriate IAM access key ID. * For HTTP bundles, Git repositories, and Subversion repositories, set "Username" to the user name. * **Password** *(string) --* When included in a request, the parameter depends on the repository type. * For Amazon S3 bundles, set "Password" to the appropriate IAM secret access key. * For HTTP bundles and Subversion repositories, set "Password" to the password. For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws- access-keys-best-practices.html. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **SshKey** *(string) --* In requests, the repository's SSH key. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **Revision** *(string) --* The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. * **DefaultSshKeyName** *(string) --* A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance. * **CreatedAt** *(string) --* The date when the stack was created. * **DefaultRootDeviceType** *(string) --* The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device. * **AgentVersion** *(string) --* The agent version. This parameter is set to "LATEST" for auto-update. or a version number for a fixed agent version. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / get_paginator get_paginator ************* OpsWorks.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. OpsWorks / Client / start_stack start_stack *********** OpsWorks.Client.start_stack(**kwargs) Starts a stack's instances. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.start_stack( StackId='string' ) Parameters: **StackId** (*string*) -- **[REQUIRED]** The stack ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_layers describe_layers *************** OpsWorks.Client.describe_layers(**kwargs) Requests a description of one or more layers in a specified stack. Note: This call accepts only one resource-identifying parameter. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_layers( StackId='string', LayerIds=[ 'string', ] ) Parameters: * **StackId** (*string*) -- The stack ID. * **LayerIds** (*list*) -- An array of layer IDs that specify the layers to be described. If you omit this parameter, "DescribeLayers" returns a description of every layer in the specified stack. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Layers': [ { 'Arn': 'string', 'StackId': 'string', 'LayerId': 'string', 'Type': 'aws-flow-ruby'|'ecs-cluster'|'java-app'|'lb'|'web'|'php-app'|'rails-app'|'nodejs-app'|'memcached'|'db-master'|'monitoring-master'|'custom', 'Name': 'string', 'Shortname': 'string', 'Attributes': { 'string': 'string' }, 'CloudWatchLogsConfiguration': { 'Enabled': True|False, 'LogStreams': [ { 'LogGroupName': 'string', 'DatetimeFormat': 'string', 'TimeZone': 'LOCAL'|'UTC', 'File': 'string', 'FileFingerprintLines': 'string', 'MultiLineStartPattern': 'string', 'InitialPosition': 'start_of_file'|'end_of_file', 'Encoding': 'ascii'|'big5'|'big5hkscs'|'cp037'|'cp424'|'cp437'|'cp500'|'cp720'|'cp737'|'cp775'|'cp850'|'cp852'|'cp855'|'cp856'|'cp857'|'cp858'|'cp860'|'cp861'|'cp862'|'cp863'|'cp864'|'cp865'|'cp866'|'cp869'|'cp874'|'cp875'|'cp932'|'cp949'|'cp950'|'cp1006'|'cp1026'|'cp1140'|'cp1250'|'cp1251'|'cp1252'|'cp1253'|'cp1254'|'cp1255'|'cp1256'|'cp1257'|'cp1258'|'euc_jp'|'euc_jis_2004'|'euc_jisx0213'|'euc_kr'|'gb2312'|'gbk'|'gb18030'|'hz'|'iso2022_jp'|'iso2022_jp_1'|'iso2022_jp_2'|'iso2022_jp_2004'|'iso2022_jp_3'|'iso2022_jp_ext'|'iso2022_kr'|'latin_1'|'iso8859_2'|'iso8859_3'|'iso8859_4'|'iso8859_5'|'iso8859_6'|'iso8859_7'|'iso8859_8'|'iso8859_9'|'iso8859_10'|'iso8859_13'|'iso8859_14'|'iso8859_15'|'iso8859_16'|'johab'|'koi8_r'|'koi8_u'|'mac_cyrillic'|'mac_greek'|'mac_iceland'|'mac_latin2'|'mac_roman'|'mac_turkish'|'ptcp154'|'shift_jis'|'shift_jis_2004'|'shift_jisx0213'|'utf_32'|'utf_32_be'|'utf_32_le'|'utf_16'|'utf_16_be'|'utf_16_le'|'utf_7'|'utf_8'|'utf_8_sig', 'BufferDuration': 123, 'BatchCount': 123, 'BatchSize': 123 }, ] }, 'CustomInstanceProfileArn': 'string', 'CustomJson': 'string', 'CustomSecurityGroupIds': [ 'string', ], 'DefaultSecurityGroupNames': [ 'string', ], 'Packages': [ 'string', ], 'VolumeConfigurations': [ { 'MountPoint': 'string', 'RaidLevel': 123, 'NumberOfDisks': 123, 'Size': 123, 'VolumeType': 'string', 'Iops': 123, 'Encrypted': True|False }, ], 'EnableAutoHealing': True|False, 'AutoAssignElasticIps': True|False, 'AutoAssignPublicIps': True|False, 'DefaultRecipes': { 'Setup': [ 'string', ], 'Configure': [ 'string', ], 'Deploy': [ 'string', ], 'Undeploy': [ 'string', ], 'Shutdown': [ 'string', ] }, 'CustomRecipes': { 'Setup': [ 'string', ], 'Configure': [ 'string', ], 'Deploy': [ 'string', ], 'Undeploy': [ 'string', ], 'Shutdown': [ 'string', ] }, 'CreatedAt': 'string', 'InstallUpdatesOnBoot': True|False, 'UseEbsOptimizedInstances': True|False, 'LifecycleEventConfiguration': { 'Shutdown': { 'ExecutionTimeout': 123, 'DelayUntilElbConnectionsDrained': True|False } } }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeLayers" request. * **Layers** *(list) --* An array of "Layer" objects that describe the layers. * *(dict) --* Describes a layer. * **Arn** *(string) --* The Amazon Resource Number (ARN) of a layer. * **StackId** *(string) --* The layer stack ID. * **LayerId** *(string) --* The layer ID. * **Type** *(string) --* The layer type. * **Name** *(string) --* The layer name. Layer names can be a maximum of 32 characters. * **Shortname** *(string) --* The layer short name. * **Attributes** *(dict) --* The layer attributes. For the "HaproxyStatsPassword", "MysqlRootPassword", and "GangliaPassword" attributes, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value For an ECS Cluster layer, OpsWorks Stacks the "EcsClusterArn" attribute is set to the cluster's ARN. * *(string) --* * *(string) --* * **CloudWatchLogsConfiguration** *(dict) --* The Amazon CloudWatch Logs configuration settings for the layer. * **Enabled** *(boolean) --* Whether CloudWatch Logs is enabled for a layer. * **LogStreams** *(list) --* A list of configuration options for CloudWatch Logs. * *(dict) --* Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference. * **LogGroupName** *(string) --* Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period). * **DatetimeFormat** *(string) --* Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference. * **TimeZone** *(string) --* Specifies the time zone of log event time stamps. * **File** *(string) --* Specifies log files that you want to push to CloudWatch Logs. "File" can point to a specific file or multiple files (by using wild card characters such as "/var/log/system.log*"). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as "access_log.2014-06-01-01", "access_log.2014-06-01-02", and so on by using a pattern like "access_log.*". Don't use a wildcard to match multiple file types, such as "access_log_80" and "access_log_443". To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group. Zipped files are not supported. * **FileFingerprintLines** *(string) --* Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available. * **MultiLineStartPattern** *(string) --* Specifies the pattern for identifying the start of a log message. * **InitialPosition** *(string) --* Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream. * **Encoding** *(string) --* Specifies the encoding of the log file so that the file can be read correctly. The default is "utf_8". Encodings supported by Python "codecs.decode()" can be used here. * **BufferDuration** *(integer) --* Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms. * **BatchCount** *(integer) --* Specifies the max number of log events in a batch, up to 10000. The default value is 1000. * **BatchSize** *(integer) --* Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. * **CustomInstanceProfileArn** *(string) --* The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers. * **CustomJson** *(string) --* A JSON formatted string containing the layer's custom stack configuration and deployment attributes. * **CustomSecurityGroupIds** *(list) --* An array containing the layer's custom security group IDs. * *(string) --* * **DefaultSecurityGroupNames** *(list) --* An array containing the layer's security group names. * *(string) --* * **Packages** *(list) --* An array of "Package" objects that describe the layer's packages. * *(string) --* * **VolumeConfigurations** *(list) --* A "VolumeConfigurations" object that describes the layer's Amazon EBS volumes. * *(dict) --* Describes an Amazon EBS volume configuration. * **MountPoint** *(string) --* The volume mount point. For example "/dev/sdh". * **RaidLevel** *(integer) --* The volume RAID level. * **NumberOfDisks** *(integer) --* The number of disks in the volume. * **Size** *(integer) --* The volume size. * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS Volume Types. * "standard" - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB. * "io1" - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB. * "gp2" - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB. * "st1" - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * "sc1" - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * **Iops** *(integer) --* For PIOPS volumes, the IOPS per disk. * **Encrypted** *(boolean) --* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption. * **EnableAutoHealing** *(boolean) --* Whether auto healing is disabled for the layer. * **AutoAssignElasticIps** *(boolean) --* Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer. * **AutoAssignPublicIps** *(boolean) --* For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer. * **DefaultRecipes** *(dict) --* OpsWorks Stacks supports five lifecycle events: **setup**, **configuration**, **deploy**, **undeploy**, and **shutdown**. For each layer, OpsWorks Stacks runs a set of standard recipes for each event. You can also provide custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the standard recipes. "LayerCustomRecipes" specifies the custom recipes for a particular layer to be run in response to each of the five events. To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the ".rb" extension. For example: "phpapp2::dbsetup" specifies the "dbsetup.rb" recipe in the repository's "phpapp2" folder. * **Setup** *(list) --* An array of custom recipe names to be run following a "setup" event. * *(string) --* * **Configure** *(list) --* An array of custom recipe names to be run following a "configure" event. * *(string) --* * **Deploy** *(list) --* An array of custom recipe names to be run following a "deploy" event. * *(string) --* * **Undeploy** *(list) --* An array of custom recipe names to be run following a "undeploy" event. * *(string) --* * **Shutdown** *(list) --* An array of custom recipe names to be run following a "shutdown" event. * *(string) --* * **CustomRecipes** *(dict) --* A "LayerCustomRecipes" object that specifies the layer's custom recipes. * **Setup** *(list) --* An array of custom recipe names to be run following a "setup" event. * *(string) --* * **Configure** *(list) --* An array of custom recipe names to be run following a "configure" event. * *(string) --* * **Deploy** *(list) --* An array of custom recipe names to be run following a "deploy" event. * *(string) --* * **Undeploy** *(list) --* An array of custom recipe names to be run following a "undeploy" event. * *(string) --* * **Shutdown** *(list) --* An array of custom recipe names to be run following a "shutdown" event. * *(string) --* * **CreatedAt** *(string) --* Date when the layer was created. * **InstallUpdatesOnBoot** *(boolean) --* Whether to install operating system and package updates when the instance boots. The default value is "true". If this value is set to "false", you must then update your instances manually by using CreateDeployment to run the "update_dependencies" stack command or manually running "yum" (Amazon Linux) or "apt-get" (Ubuntu) on the instances. Note: We strongly recommend using the default value of "true", to ensure that your instances have the latest security updates. * **UseEbsOptimizedInstances** *(boolean) --* Whether the layer uses Amazon EBS-optimized instances. * **LifecycleEventConfiguration** *(dict) --* A "LifeCycleEventConfiguration" object that specifies the Shutdown event configuration. * **Shutdown** *(dict) --* A "ShutdownEventConfiguration" object that specifies the Shutdown event configuration. * **ExecutionTimeout** *(integer) --* The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before shutting down an instance. * **DelayUntilElbConnectionsDrained** *(boolean) --* Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / unassign_instance unassign_instance ***************** OpsWorks.Client.unassign_instance(**kwargs) Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with OpsWorks Stacks. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.unassign_instance( InstanceId='string' ) Parameters: **InstanceId** (*string*) -- **[REQUIRED]** The instance ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_my_user_profile describe_my_user_profile ************************ OpsWorks.Client.describe_my_user_profile() Describes a user's SSH information. **Required Permissions**: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_my_user_profile() Return type: dict Returns: **Response Syntax** { 'UserProfile': { 'IamUserArn': 'string', 'Name': 'string', 'SshUsername': 'string', 'SshPublicKey': 'string' } } **Response Structure** * *(dict) --* Contains the response to a "DescribeMyUserProfile" request. * **UserProfile** *(dict) --* A "UserProfile" object that describes the user's SSH information. * **IamUserArn** *(string) --* The user's IAM ARN. * **Name** *(string) --* The user's name. * **SshUsername** *(string) --* The user's SSH user name. * **SshPublicKey** *(string) --* The user's SSH public key. OpsWorks / Client / set_load_based_auto_scaling set_load_based_auto_scaling *************************** OpsWorks.Client.set_load_based_auto_scaling(**kwargs) Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances. Note: To use load-based auto scaling, you must create a set of load- based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.set_load_based_auto_scaling( LayerId='string', Enable=True|False, UpScaling={ 'InstanceCount': 123, 'ThresholdsWaitTime': 123, 'IgnoreMetricsTime': 123, 'CpuThreshold': 123.0, 'MemoryThreshold': 123.0, 'LoadThreshold': 123.0, 'Alarms': [ 'string', ] }, DownScaling={ 'InstanceCount': 123, 'ThresholdsWaitTime': 123, 'IgnoreMetricsTime': 123, 'CpuThreshold': 123.0, 'MemoryThreshold': 123.0, 'LoadThreshold': 123.0, 'Alarms': [ 'string', ] } ) Parameters: * **LayerId** (*string*) -- **[REQUIRED]** The layer ID. * **Enable** (*boolean*) -- Enables load-based auto scaling for the layer. * **UpScaling** (*dict*) -- An "AutoScalingThresholds" object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, OpsWorks Stacks starts a specified number of instances. * **InstanceCount** *(integer) --* The number of instances to add or remove when the load exceeds a threshold. * **ThresholdsWaitTime** *(integer) --* The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed. * **IgnoreMetricsTime** *(integer) --* The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. "IgnoreMetricsTime" allows you to direct OpsWorks Stacks to suppress scaling events long enough to get the new instances online. * **CpuThreshold** *(float) --* The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold. * **MemoryThreshold** *(float) --* The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold. * **LoadThreshold** *(float) --* The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing). * **Alarms** *(list) --* Custom CloudWatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack. Note: To use custom alarms, you must update your service role to allow "cloudwatch:DescribeAlarms". You can either have OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing OpsWorks Stacks to Act on Your Behalf. * *(string) --* * **DownScaling** (*dict*) -- An "AutoScalingThresholds" object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, OpsWorks Stacks stops a specified number of instances. * **InstanceCount** *(integer) --* The number of instances to add or remove when the load exceeds a threshold. * **ThresholdsWaitTime** *(integer) --* The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed. * **IgnoreMetricsTime** *(integer) --* The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. "IgnoreMetricsTime" allows you to direct OpsWorks Stacks to suppress scaling events long enough to get the new instances online. * **CpuThreshold** *(float) --* The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold. * **MemoryThreshold** *(float) --* The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold. * **LoadThreshold** *(float) --* The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing). * **Alarms** *(list) --* Custom CloudWatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack. Note: To use custom alarms, you must update your service role to allow "cloudwatch:DescribeAlarms". You can either have OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing OpsWorks Stacks to Act on Your Behalf. * *(string) --* Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / can_paginate can_paginate ************ OpsWorks.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. OpsWorks / Client / unassign_volume unassign_volume *************** OpsWorks.Client.unassign_volume(**kwargs) Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.unassign_volume( VolumeId='string' ) Parameters: **VolumeId** (*string*) -- **[REQUIRED]** The volume ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / create_stack create_stack ************ OpsWorks.Client.create_stack(**kwargs) Creates a new stack. For more information, see Create a New Stack. **Required Permissions**: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.create_stack( Name='string', Region='string', VpcId='string', Attributes={ 'string': 'string' }, ServiceRoleArn='string', DefaultInstanceProfileArn='string', DefaultOs='string', HostnameTheme='string', DefaultAvailabilityZone='string', DefaultSubnetId='string', CustomJson='string', ConfigurationManager={ 'Name': 'string', 'Version': 'string' }, ChefConfiguration={ 'ManageBerkshelf': True|False, 'BerkshelfVersion': 'string' }, UseCustomCookbooks=True|False, UseOpsworksSecurityGroups=True|False, CustomCookbooksSource={ 'Type': 'git'|'svn'|'archive'|'s3', 'Url': 'string', 'Username': 'string', 'Password': 'string', 'SshKey': 'string', 'Revision': 'string' }, DefaultSshKeyName='string', DefaultRootDeviceType='ebs'|'instance-store', AgentVersion='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The stack name. Stack names can be a maximum of 64 characters. * **Region** (*string*) -- **[REQUIRED]** The stack's Amazon Web Services Region, such as "ap-south-1". For more information about Amazon Web Services Regions, see Regions and Endpoints. Note: In the CLI, this API maps to the "--stack-region" parameter. If the "--stack-region" parameter and the CLI common parameter "--region" are set to the same value, the stack uses a *regional* endpoint. If the "--stack-region" parameter is not set, but the CLI "--region" parameter is, this also results in a stack with a *regional* endpoint. However, if the "--region" parameter is set to "us-east-1", and the "--stack-region" parameter is set to one of the following, then the stack uses a legacy or *classic* region: "us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2". In this case, the actual API endpoint of the stack is in "us- east-1". Only the preceding regions are supported as classic regions in the "us-east-1" API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage Amazon Web Services, we recommend that you use regional endpoints for new stacks. The CLI common "--region" parameter always specifies a regional API endpoint; it cannot be used to specify a classic OpsWorks Stacks region. * **VpcId** (*string*) -- The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later. * If your account supports EC2-Classic, the default value is "no VPC". * If your account does not support EC2-Classic, the default value is the default VPC for the specified region. If the VPC ID corresponds to a default VPC and you have specified either the "DefaultAvailabilityZone" or the "DefaultSubnetId" parameter only, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. If you specify a nondefault VPC ID, note the following: * It must belong to a VPC in your account that is in the specified region. * You must specify a value for "DefaultSubnetId". For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms. * **Attributes** (*dict*) -- One or more user-defined key-value pairs to be added to the stack attributes. * *(string) --* * *(string) --* * **ServiceRoleArn** (*string*) -- **[REQUIRED]** The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers. * **DefaultInstanceProfileArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. * **DefaultOs** (*string*) -- The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following. * A supported Linux operating system: An Amazon Linux version, such as "Amazon Linux 2", "Amazon Linux 2018.03", "Amazon Linux 2017.09", "Amazon Linux 2017.03", "Amazon Linux 2016.09", "Amazon Linux 2016.03", "Amazon Linux 2015.09", or "Amazon Linux 2015.03". * A supported Ubuntu operating system, such as "Ubuntu 18.04 LTS", "Ubuntu 16.04 LTS", "Ubuntu 14.04 LTS", or "Ubuntu 12.04 LTS". * "CentOS Linux 7" * "Red Hat Enterprise Linux 7" * A supported Windows operating system, such as "Microsoft Windows Server 2012 R2 Base", "Microsoft Windows Server 2012 R2 with SQL Server Express", "Microsoft Windows Server 2012 R2 with SQL Server Standard", or "Microsoft Windows Server 2012 R2 with SQL Server Web". * A custom AMI: "Custom". You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs. The default option is the current Amazon Linux version. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems. * **HostnameTheme** (*string*) -- The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, "HostnameTheme" is set to "Layer_Dependent", which creates host names by appending integers to the layer's short name. The other themes are: * "Baked_Goods" * "Clouds" * "Europe_Cities" * "Fruits" * "Greek_Deities_and_Titans" * "Legendary_creatures_from_Japan" * "Planets_and_Moons" * "Roman_Deities" * "Scottish_Islands" * "US_Cities" * "Wild_Cats" To obtain a generated host name, call "GetHostNameSuggestion", which returns a host name based on the current theme. * **DefaultAvailabilityZone** (*string*) -- The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for "DefaultSubnetId", the subnet must be in the same zone. For more information, see the "VpcId" parameter description. * **DefaultSubnetId** (*string*) -- The stack's default VPC subnet ID. This parameter is required if you specify a value for the "VpcId" parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for "DefaultAvailabilityZone", the subnet must be in that zone. For information on default values and when this parameter is required, see the "VpcId" parameter description. * **CustomJson** (*string*) -- A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format: ""{\"key1\": \"value1\", \"key2\": \"value2\",...}"" For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. * **ConfigurationManager** (*dict*) -- The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. * **Name** *(string) --* The name. This parameter must be set to "Chef". * **Version** *(string) --* The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12. * **ChefConfiguration** (*dict*) -- A "ChefConfiguration" object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack. * **ManageBerkshelf** *(boolean) --* Whether to enable Berkshelf. * **BerkshelfVersion** *(string) --* The Berkshelf version. * **UseCustomCookbooks** (*boolean*) -- Whether the stack uses custom cookbooks. * **UseOpsworksSecurityGroups** (*boolean*) -- Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers. OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With "UseOpsworksSecurityGroups" you can instead provide your own custom security groups. "UseOpsworksSecurityGroups" has the following settings: * True - OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. * False - OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. For more information, see Create a New Stack. * **CustomCookbooksSource** (*dict*) -- Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes. * **Type** *(string) --* The repository type. * **Url** *(string) --* The source URL. The following is an example of an Amazon S3 source URL: "https://s3.amazonaws.com/opsworks-demo- bucket/opsworks_cookbook_demo.tar.gz". * **Username** *(string) --* This parameter depends on the repository type. * For Amazon S3 bundles, set "Username" to the appropriate IAM access key ID. * For HTTP bundles, Git repositories, and Subversion repositories, set "Username" to the user name. * **Password** *(string) --* When included in a request, the parameter depends on the repository type. * For Amazon S3 bundles, set "Password" to the appropriate IAM secret access key. * For HTTP bundles and Subversion repositories, set "Password" to the password. For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access- keys-best-practices.html. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **SshKey** *(string) --* In requests, the repository's SSH key. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **Revision** *(string) --* The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. * **DefaultSshKeyName** (*string*) -- A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance. * **DefaultRootDeviceType** (*string*) -- The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is "instance-store". For more information, see Storage for the Root Device. * **AgentVersion** (*string*) -- The default OpsWorks Stacks agent version. You have the following options: * Auto-update - Set this parameter to "LATEST". OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. * Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. OpsWorks Stacks installs that version on the stack's instances. The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. Note: You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. Return type: dict Returns: **Response Syntax** { 'StackId': 'string' } **Response Structure** * *(dict) --* Contains the response to a "CreateStack" request. * **StackId** *(string) --* The stack ID, which is an opaque string that you use to identify the stack when performing actions such as "DescribeStacks". **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" OpsWorks / Client / list_tags list_tags ********* OpsWorks.Client.list_tags(**kwargs) Returns a list of tags that are applied to the specified stack or layer. See also: AWS API Documentation **Request Syntax** response = client.list_tags( ResourceArn='string', MaxResults=123, NextToken='string' ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The stack or layer's Amazon Resource Number (ARN). * **MaxResults** (*integer*) -- Do not use. A validation exception occurs if you add a "MaxResults" parameter to a "ListTagsRequest" call. * **NextToken** (*string*) -- Do not use. A validation exception occurs if you add a "NextToken" parameter to a "ListTagsRequest" call. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' }, 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the response to a "ListTags" request. * **Tags** *(dict) --* A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer. * *(string) --* * *(string) --* * **NextToken** *(string) --* If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's "NextToken" parameter to get the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to "null". **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_instances describe_instances ****************** OpsWorks.Client.describe_instances(**kwargs) Requests a description of a set of instances. Note: This call accepts only one resource-identifying parameter. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_instances( StackId='string', LayerId='string', InstanceIds=[ 'string', ] ) Parameters: * **StackId** (*string*) -- A stack ID. If you use this parameter, "DescribeInstances" returns descriptions of the instances associated with the specified stack. * **LayerId** (*string*) -- A layer ID. If you use this parameter, "DescribeInstances" returns descriptions of the instances associated with the specified layer. * **InstanceIds** (*list*) -- An array of instance IDs to be described. If you use this parameter, "DescribeInstances" returns a description of the specified instances. Otherwise, it returns a description of every instance. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Instances': [ { 'AgentVersion': 'string', 'AmiId': 'string', 'Architecture': 'x86_64'|'i386', 'Arn': 'string', 'AutoScalingType': 'load'|'timer', 'AvailabilityZone': 'string', 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'NoDevice': 'string', 'VirtualName': 'string', 'Ebs': { 'SnapshotId': 'string', 'Iops': 123, 'VolumeSize': 123, 'VolumeType': 'gp2'|'io1'|'standard', 'DeleteOnTermination': True|False } }, ], 'CreatedAt': 'string', 'EbsOptimized': True|False, 'Ec2InstanceId': 'string', 'EcsClusterArn': 'string', 'EcsContainerInstanceArn': 'string', 'ElasticIp': 'string', 'Hostname': 'string', 'InfrastructureClass': 'string', 'InstallUpdatesOnBoot': True|False, 'InstanceId': 'string', 'InstanceProfileArn': 'string', 'InstanceType': 'string', 'LastServiceErrorId': 'string', 'LayerIds': [ 'string', ], 'Os': 'string', 'Platform': 'string', 'PrivateDns': 'string', 'PrivateIp': 'string', 'PublicDns': 'string', 'PublicIp': 'string', 'RegisteredBy': 'string', 'ReportedAgentVersion': 'string', 'ReportedOs': { 'Family': 'string', 'Name': 'string', 'Version': 'string' }, 'RootDeviceType': 'ebs'|'instance-store', 'RootDeviceVolumeId': 'string', 'SecurityGroupIds': [ 'string', ], 'SshHostDsaKeyFingerprint': 'string', 'SshHostRsaKeyFingerprint': 'string', 'SshKeyName': 'string', 'StackId': 'string', 'Status': 'string', 'SubnetId': 'string', 'Tenancy': 'string', 'VirtualizationType': 'paravirtual'|'hvm' }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeInstances" request. * **Instances** *(list) --* An array of "Instance" objects that describe the instances. * *(dict) --* Describes an instance. * **AgentVersion** *(string) --* The agent version. This parameter is set to "INHERIT" if the instance inherits the default stack setting or to a a version number for a fixed agent version. * **AmiId** *(string) --* A custom AMI ID to be used to create the instance. For more information, see Instances * **Architecture** *(string) --* The instance architecture: "i386" or "x86_64". * **Arn** *(string) --* The instance's Amazon Resource Number (ARN). * **AutoScalingType** *(string) --* For load-based or time-based instances, the type. * **AvailabilityZone** *(string) --* The instance Availability Zone. For more information, see Regions and Endpoints. * **BlockDeviceMappings** *(list) --* An array of "BlockDeviceMapping" objects that specify the instance's block device mappings. * *(dict) --* Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type. * **DeviceName** *(string) --* The device name that is exposed to the instance, such as "/dev/sdh". For the root device, you can use the explicit device name or you can set this parameter to "ROOT_DEVICE" and OpsWorks Stacks will provide the correct device name. * **NoDevice** *(string) --* Suppresses the specified device included in the AMI's block device mapping. * **VirtualName** *(string) --* The virtual device name. For more information, see BlockDeviceMapping. * **Ebs** *(dict) --* An "EBSBlockDevice" that defines how to configure an Amazon EBS volume when the instance is launched. * **SnapshotId** *(string) --* The snapshot ID. * **Iops** *(integer) --* The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice. * **VolumeSize** *(integer) --* The volume size, in GiB. For more information, see EbsBlockDevice. * **VolumeType** *(string) --* The volume type. "gp2" for General Purpose (SSD) volumes, "io1" for Provisioned IOPS (SSD) volumes, "st1" for Throughput Optimized hard disk drives (HDD), "sc1" for Cold HDD,and "standard" for Magnetic volumes. If you specify the "io1" volume type, you must also specify a value for the "Iops" attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. Amazon Web Services uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size). * **DeleteOnTermination** *(boolean) --* Whether the volume is deleted on instance termination. * **CreatedAt** *(string) --* The time that the instance was created. * **EbsOptimized** *(boolean) --* Whether this is an Amazon EBS-optimized instance. * **Ec2InstanceId** *(string) --* The ID of the associated Amazon EC2 instance. * **EcsClusterArn** *(string) --* For container instances, the Amazon ECS cluster's ARN. * **EcsContainerInstanceArn** *(string) --* For container instances, the instance's ARN. * **ElasticIp** *(string) --* The instance Elastic IP address. * **Hostname** *(string) --* The instance host name. The following are character limits for instance host names. * Linux-based instances: 63 characters * Windows-based instances: 15 characters * **InfrastructureClass** *(string) --* For registered instances, the infrastructure class: "ec2" or "on-premises". * **InstallUpdatesOnBoot** *(boolean) --* Whether to install operating system and package updates when the instance boots. The default value is "true". If this value is set to "false", you must update instances manually by using CreateDeployment to run the "update_dependencies" stack command or by manually running "yum" (Amazon Linux) or "apt-get" (Ubuntu) on the instances. Note: We strongly recommend using the default value of "true" to ensure that your instances have the latest security updates. * **InstanceId** *(string) --* The instance ID. * **InstanceProfileArn** *(string) --* The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers. * **InstanceType** *(string) --* The instance type, such as "t2.micro". * **LastServiceErrorId** *(string) --* The ID of the last service error. For more information, call DescribeServiceErrors. * **LayerIds** *(list) --* An array containing the instance layer IDs. * *(string) --* * **Os** *(string) --* The instance's operating system. * **Platform** *(string) --* The instance's platform. * **PrivateDns** *(string) --* The instance's private DNS name. * **PrivateIp** *(string) --* The instance's private IP address. * **PublicDns** *(string) --* The instance public DNS name. * **PublicIp** *(string) --* The instance public IP address. * **RegisteredBy** *(string) --* For registered instances, who performed the registration. * **ReportedAgentVersion** *(string) --* The instance's reported OpsWorks Stacks agent version. * **ReportedOs** *(dict) --* For registered instances, the reported operating system. * **Family** *(string) --* The operating system family. * **Name** *(string) --* The operating system name. * **Version** *(string) --* The operating system version. * **RootDeviceType** *(string) --* The instance's root device type. For more information, see Storage for the Root Device. * **RootDeviceVolumeId** *(string) --* The root device volume ID. * **SecurityGroupIds** *(list) --* An array containing the instance security group IDs. * *(string) --* * **SshHostDsaKeyFingerprint** *(string) --* The SSH key's Deep Security Agent (DSA) fingerprint. * **SshHostRsaKeyFingerprint** *(string) --* The SSH key's RSA fingerprint. * **SshKeyName** *(string) --* The instance's Amazon EC2 key-pair name. * **StackId** *(string) --* The stack ID. * **Status** *(string) --* The instance status: * "booting" * "connection_lost" * "online" * "pending" * "rebooting" * "requested" * "running_setup" * "setup_failed" * "shutting_down" * "start_failed" * "stop_failed" * "stopped" * "stopping" * "terminated" * "terminating" * **SubnetId** *(string) --* The instance's subnet ID; applicable only if the stack is running in a VPC. * **Tenancy** *(string) --* The instance's tenancy option, such as "dedicated" or "host". * **VirtualizationType** *(string) --* The instance's virtualization type: "paravirtual" or "hvm". **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_user_profiles describe_user_profiles ********************** OpsWorks.Client.describe_user_profiles(**kwargs) Describe specified users. **Required Permissions**: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_user_profiles( IamUserArns=[ 'string', ] ) Parameters: **IamUserArns** (*list*) -- An array of IAM or federated user ARNs that identify the users to be described. * *(string) --* Return type: dict Returns: **Response Syntax** { 'UserProfiles': [ { 'IamUserArn': 'string', 'Name': 'string', 'SshUsername': 'string', 'SshPublicKey': 'string', 'AllowSelfManagement': True|False }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeUserProfiles" request. * **UserProfiles** *(list) --* A "Users" object that describes the specified users. * *(dict) --* Describes a user's SSH information. * **IamUserArn** *(string) --* The user's IAM ARN. * **Name** *(string) --* The user's name. * **SshUsername** *(string) --* The user's SSH user name. * **SshPublicKey** *(string) --* The user's SSH public key. * **AllowSelfManagement** *(boolean) --* Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / deregister_elastic_ip deregister_elastic_ip ********************* OpsWorks.Client.deregister_elastic_ip(**kwargs) Deregisters a specified Elastic IP address. The address can be registered by another stack after it is deregistered. For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.deregister_elastic_ip( ElasticIp='string' ) Parameters: **ElasticIp** (*string*) -- **[REQUIRED]** The Elastic IP address. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / update_elastic_ip update_elastic_ip ***************** OpsWorks.Client.update_elastic_ip(**kwargs) Updates a registered Elastic IP address's name. For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.update_elastic_ip( ElasticIp='string', Name='string' ) Parameters: * **ElasticIp** (*string*) -- **[REQUIRED]** The IP address for which you want to update the name. * **Name** (*string*) -- The new name, which can be a maximum of 32 characters. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / update_volume update_volume ************* OpsWorks.Client.update_volume(**kwargs) Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.update_volume( VolumeId='string', Name='string', MountPoint='string' ) Parameters: * **VolumeId** (*string*) -- **[REQUIRED]** The volume ID. * **Name** (*string*) -- The new name. Volume names can be a maximum of 128 characters. * **MountPoint** (*string*) -- The new mount point. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_ecs_clusters describe_ecs_clusters ********************* OpsWorks.Client.describe_ecs_clusters(**kwargs) Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the "MaxResults" and "NextToken" parameters to paginate the response. However, OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. See also: AWS API Documentation **Request Syntax** response = client.describe_ecs_clusters( EcsClusterArns=[ 'string', ], StackId='string', NextToken='string', MaxResults=123 ) Parameters: * **EcsClusterArns** (*list*) -- A list of ARNs, one for each cluster to be described. * *(string) --* * **StackId** (*string*) -- A stack ID. "DescribeEcsClusters" returns a description of the cluster that is registered with the stack. * **NextToken** (*string*) -- If the previous paginated request did not return all of the remaining results, the response object's "NextToken" parameter value is set to a token. To retrieve the next set of results, call "DescribeEcsClusters" again and assign that token to the request object's "NextToken" parameter. If there are no remaining results, the previous response object's "NextToken" parameter is set to "null". * **MaxResults** (*integer*) -- To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a "NextToken" value that you can assign to the "NextToken" request parameter to get the next set of results. Return type: dict Returns: **Response Syntax** { 'EcsClusters': [ { 'EcsClusterArn': 'string', 'EcsClusterName': 'string', 'StackId': 'string', 'RegisteredAt': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the response to a "DescribeEcsClusters" request. * **EcsClusters** *(list) --* A list of "EcsCluster" objects containing the cluster descriptions. * *(dict) --* Describes a registered Amazon ECS cluster. * **EcsClusterArn** *(string) --* The cluster's ARN. * **EcsClusterName** *(string) --* The cluster name. * **StackId** *(string) --* The stack ID. * **RegisteredAt** *(string) --* The time and date that the cluster was registered with the stack. * **NextToken** *(string) --* If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's "NextToken" parameter to retrieve the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to "null". **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / update_stack update_stack ************ OpsWorks.Client.update_stack(**kwargs) Updates a specified stack. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.update_stack( StackId='string', Name='string', Attributes={ 'string': 'string' }, ServiceRoleArn='string', DefaultInstanceProfileArn='string', DefaultOs='string', HostnameTheme='string', DefaultAvailabilityZone='string', DefaultSubnetId='string', CustomJson='string', ConfigurationManager={ 'Name': 'string', 'Version': 'string' }, ChefConfiguration={ 'ManageBerkshelf': True|False, 'BerkshelfVersion': 'string' }, UseCustomCookbooks=True|False, CustomCookbooksSource={ 'Type': 'git'|'svn'|'archive'|'s3', 'Url': 'string', 'Username': 'string', 'Password': 'string', 'SshKey': 'string', 'Revision': 'string' }, DefaultSshKeyName='string', DefaultRootDeviceType='ebs'|'instance-store', UseOpsworksSecurityGroups=True|False, AgentVersion='string' ) Parameters: * **StackId** (*string*) -- **[REQUIRED]** The stack ID. * **Name** (*string*) -- The stack's new name. Stack names can be a maximum of 64 characters. * **Attributes** (*dict*) -- One or more user-defined key-value pairs to be added to the stack attributes. * *(string) --* * *(string) --* * **ServiceRoleArn** (*string*) -- Do not use this parameter. You cannot update a stack's service role. * **DefaultInstanceProfileArn** (*string*) -- The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. * **DefaultOs** (*string*) -- The stack's operating system, which must be set to one of the following: * A supported Linux operating system: An Amazon Linux version, such as "Amazon Linux 2", "Amazon Linux 2018.03", "Amazon Linux 2017.09", "Amazon Linux 2017.03", "Amazon Linux 2016.09", "Amazon Linux 2016.03", "Amazon Linux 2015.09", or "Amazon Linux 2015.03". * A supported Ubuntu operating system, such as "Ubuntu 18.04 LTS", "Ubuntu 16.04 LTS", "Ubuntu 14.04 LTS", or "Ubuntu 12.04 LTS". * "CentOS Linux 7" * "Red Hat Enterprise Linux 7" * A supported Windows operating system, such as "Microsoft Windows Server 2012 R2 Base", "Microsoft Windows Server 2012 R2 with SQL Server Express", "Microsoft Windows Server 2012 R2 with SQL Server Standard", or "Microsoft Windows Server 2012 R2 with SQL Server Web". * A custom AMI: "Custom". You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs. The default option is the stack's current operating system. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems. * **HostnameTheme** (*string*) -- The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, "HostnameTheme" is set to "Layer_Dependent", which creates host names by appending integers to the layer's short name. The other themes are: * "Baked_Goods" * "Clouds" * "Europe_Cities" * "Fruits" * "Greek_Deities_and_Titans" * "Legendary_creatures_from_Japan" * "Planets_and_Moons" * "Roman_Deities" * "Scottish_Islands" * "US_Cities" * "Wild_Cats" To obtain a generated host name, call "GetHostNameSuggestion", which returns a host name based on the current theme. * **DefaultAvailabilityZone** (*string*) -- The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for "DefaultSubnetId", the subnet must be in the same zone. For more information, see CreateStack. * **DefaultSubnetId** (*string*) -- The stack's default VPC subnet ID. This parameter is required if you specify a value for the "VpcId" parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for "DefaultAvailabilityZone", the subnet must be in that zone. For information on default values and when this parameter is required, see the "VpcId" parameter description. * **CustomJson** (*string*) -- A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format: ""{\"key1\": \"value1\", \"key2\": \"value2\",...}"" For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. * **ConfigurationManager** (*dict*) -- The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. * **Name** *(string) --* The name. This parameter must be set to "Chef". * **Version** *(string) --* The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12. * **ChefConfiguration** (*dict*) -- A "ChefConfiguration" object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack. * **ManageBerkshelf** *(boolean) --* Whether to enable Berkshelf. * **BerkshelfVersion** *(string) --* The Berkshelf version. * **UseCustomCookbooks** (*boolean*) -- Whether the stack uses custom cookbooks. * **CustomCookbooksSource** (*dict*) -- Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes. * **Type** *(string) --* The repository type. * **Url** *(string) --* The source URL. The following is an example of an Amazon S3 source URL: "https://s3.amazonaws.com/opsworks-demo- bucket/opsworks_cookbook_demo.tar.gz". * **Username** *(string) --* This parameter depends on the repository type. * For Amazon S3 bundles, set "Username" to the appropriate IAM access key ID. * For HTTP bundles, Git repositories, and Subversion repositories, set "Username" to the user name. * **Password** *(string) --* When included in a request, the parameter depends on the repository type. * For Amazon S3 bundles, set "Password" to the appropriate IAM secret access key. * For HTTP bundles and Subversion repositories, set "Password" to the password. For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access- keys-best-practices.html. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **SshKey** *(string) --* In requests, the repository's SSH key. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **Revision** *(string) --* The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. * **DefaultSshKeyName** (*string*) -- A default Amazon EC2 key- pair name. The default value is "none". If you specify a key- pair name, OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance. * **DefaultRootDeviceType** (*string*) -- The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device. * **UseOpsworksSecurityGroups** (*boolean*) -- Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers. OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. "UseOpsworksSecurityGroups" allows you to provide your own custom security groups instead of using the built-in groups. "UseOpsworksSecurityGroups" has the following settings: * True - OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. * False - OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings. For more information, see Create a New Stack. * **AgentVersion** (*string*) -- The default OpsWorks Stacks agent version. You have the following options: * Auto-update - Set this parameter to "LATEST". OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. * Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. OpsWorks Stacks installs that version on the stack's instances. The default setting is "LATEST". To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. Note: You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / create_instance create_instance *************** OpsWorks.Client.create_instance(**kwargs) Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.create_instance( StackId='string', LayerIds=[ 'string', ], InstanceType='string', AutoScalingType='load'|'timer', Hostname='string', Os='string', AmiId='string', SshKeyName='string', AvailabilityZone='string', VirtualizationType='string', SubnetId='string', Architecture='x86_64'|'i386', RootDeviceType='ebs'|'instance-store', BlockDeviceMappings=[ { 'DeviceName': 'string', 'NoDevice': 'string', 'VirtualName': 'string', 'Ebs': { 'SnapshotId': 'string', 'Iops': 123, 'VolumeSize': 123, 'VolumeType': 'gp2'|'io1'|'standard', 'DeleteOnTermination': True|False } }, ], InstallUpdatesOnBoot=True|False, EbsOptimized=True|False, AgentVersion='string', Tenancy='string' ) Parameters: * **StackId** (*string*) -- **[REQUIRED]** The stack ID. * **LayerIds** (*list*) -- **[REQUIRED]** An array that contains the instance's layer IDs. * *(string) --* * **InstanceType** (*string*) -- **[REQUIRED]** The instance type, such as "t2.micro". For a list of supported instance types, open the stack in the console, choose **Instances**, and choose **+ Instance**. The **Size** list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the **API Name** column of the **Available Instance Types** table. * **AutoScalingType** (*string*) -- For load-based or time-based instances, the type. Windows stacks can use only time-based instances. * **Hostname** (*string*) -- The instance host name. The following are character limits for instance host names. * Linux-based instances: 63 characters * Windows-based instances: 15 characters * **Os** (*string*) -- The instance's operating system, which must be set to one of the following. * A supported Linux operating system: An Amazon Linux version, such as "Amazon Linux 2", "Amazon Linux 2018.03", "Amazon Linux 2017.09", "Amazon Linux 2017.03", "Amazon Linux 2016.09", "Amazon Linux 2016.03", "Amazon Linux 2015.09", or "Amazon Linux 2015.03". * A supported Ubuntu operating system, such as "Ubuntu 18.04 LTS", "Ubuntu 16.04 LTS", "Ubuntu 14.04 LTS", or "Ubuntu 12.04 LTS". * "CentOS Linux 7" * "Red Hat Enterprise Linux 7" * A supported Windows operating system, such as "Microsoft Windows Server 2012 R2 Base", "Microsoft Windows Server 2012 R2 with SQL Server Express", "Microsoft Windows Server 2012 R2 with SQL Server Standard", or "Microsoft Windows Server 2012 R2 with SQL Server Web". * A custom AMI: "Custom". Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see OpsWorks Stacks Operating Systems. The default option is the current Amazon Linux version. If you set this parameter to "Custom", you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is "Custom". For more information about how to use custom AMIs with OpsWorks Stacks, see Using Custom AMIs. * **AmiId** (*string*) -- A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs. Note: If you specify a custom AMI, you must set "Os" to "Custom". * **SshKeyName** (*string*) -- The instance's Amazon EC2 key- pair name. * **AvailabilityZone** (*string*) -- The instance Availability Zone. For more information, see Regions and Endpoints. * **VirtualizationType** (*string*) -- The instance's virtualization type, "paravirtual" or "hvm". * **SubnetId** (*string*) -- The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet. * **Architecture** (*string*) -- The instance architecture. The default option is "x86_64". Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types. * **RootDeviceType** (*string*) -- The instance root device type. For more information, see Storage for the Root Device. * **BlockDeviceMappings** (*list*) -- An array of "BlockDeviceMapping" objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs. * *(dict) --* Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type. * **DeviceName** *(string) --* The device name that is exposed to the instance, such as "/dev/sdh". For the root device, you can use the explicit device name or you can set this parameter to "ROOT_DEVICE" and OpsWorks Stacks will provide the correct device name. * **NoDevice** *(string) --* Suppresses the specified device included in the AMI's block device mapping. * **VirtualName** *(string) --* The virtual device name. For more information, see BlockDeviceMapping. * **Ebs** *(dict) --* An "EBSBlockDevice" that defines how to configure an Amazon EBS volume when the instance is launched. * **SnapshotId** *(string) --* The snapshot ID. * **Iops** *(integer) --* The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice. * **VolumeSize** *(integer) --* The volume size, in GiB. For more information, see EbsBlockDevice. * **VolumeType** *(string) --* The volume type. "gp2" for General Purpose (SSD) volumes, "io1" for Provisioned IOPS (SSD) volumes, "st1" for Throughput Optimized hard disk drives (HDD), "sc1" for Cold HDD,and "standard" for Magnetic volumes. If you specify the "io1" volume type, you must also specify a value for the "Iops" attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. Amazon Web Services uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size). * **DeleteOnTermination** *(boolean) --* Whether the volume is deleted on instance termination. * **InstallUpdatesOnBoot** (*boolean*) -- Whether to install operating system and package updates when the instance boots. The default value is "true". To control when updates are installed, set this value to "false". You must then update your instances manually by using CreateDeployment to run the "update_dependencies" stack command or by manually running "yum" (Amazon Linux) or "apt- get" (Ubuntu) on the instances. Note: We strongly recommend using the default value of "true" to ensure that your instances have the latest security updates. * **EbsOptimized** (*boolean*) -- Whether to create an Amazon EBS-optimized instance. * **AgentVersion** (*string*) -- The default OpsWorks Stacks agent version. You have the following options: * "INHERIT" - Use the stack's default agent version setting. * *version_number* - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. OpsWorks Stacks installs that version on the instance. The default setting is "INHERIT". To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. * **Tenancy** (*string*) -- The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: "dedicated", "default", or "host". Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances. Return type: dict Returns: **Response Syntax** { 'InstanceId': 'string' } **Response Structure** * *(dict) --* Contains the response to a "CreateInstance" request. * **InstanceId** *(string) --* The instance ID. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / get_hostname_suggestion get_hostname_suggestion *********************** OpsWorks.Client.get_hostname_suggestion(**kwargs) Gets a generated host name for the specified layer, based on the current host name theme. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.get_hostname_suggestion( LayerId='string' ) Parameters: **LayerId** (*string*) -- **[REQUIRED]** The layer ID. Return type: dict Returns: **Response Syntax** { 'LayerId': 'string', 'Hostname': 'string' } **Response Structure** * *(dict) --* Contains the response to a "GetHostnameSuggestion" request. * **LayerId** *(string) --* The layer ID. * **Hostname** *(string) --* The generated host name. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / start_instance start_instance ************** OpsWorks.Client.start_instance(**kwargs) Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.start_instance( InstanceId='string' ) Parameters: **InstanceId** (*string*) -- **[REQUIRED]** The instance ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / untag_resource untag_resource ************** OpsWorks.Client.untag_resource(**kwargs) Removes tags from a specified stack or layer. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The stack or layer's Amazon Resource Number (ARN). * **TagKeys** (*list*) -- **[REQUIRED]** A list of the keys of tags to be removed from a stack or layer. * *(string) --* Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / delete_user_profile delete_user_profile ******************* OpsWorks.Client.delete_user_profile(**kwargs) Deletes a user profile. **Required Permissions**: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.delete_user_profile( IamUserArn='string' ) Parameters: **IamUserArn** (*string*) -- **[REQUIRED]** The user's IAM ARN. This can also be a federated user's ARN. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_elastic_load_balancers describe_elastic_load_balancers ******************************* OpsWorks.Client.describe_elastic_load_balancers(**kwargs) Describes a stack's Elastic Load Balancing instances. Note: This call accepts only one resource-identifying parameter. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_elastic_load_balancers( StackId='string', LayerIds=[ 'string', ] ) Parameters: * **StackId** (*string*) -- A stack ID. The action describes the stack's Elastic Load Balancing instances. * **LayerIds** (*list*) -- A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ElasticLoadBalancers': [ { 'ElasticLoadBalancerName': 'string', 'Region': 'string', 'DnsName': 'string', 'StackId': 'string', 'LayerId': 'string', 'VpcId': 'string', 'AvailabilityZones': [ 'string', ], 'SubnetIds': [ 'string', ], 'Ec2InstanceIds': [ 'string', ] }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeElasticLoadBalancers" request. * **ElasticLoadBalancers** *(list) --* A list of "ElasticLoadBalancer" objects that describe the specified Elastic Load Balancing instances. * *(dict) --* Describes an Elastic Load Balancing instance. * **ElasticLoadBalancerName** *(string) --* The Elastic Load Balancing instance name. * **Region** *(string) --* The instance's Amazon Web Services Region. * **DnsName** *(string) --* The instance's public DNS name. * **StackId** *(string) --* The ID of the stack with which the instance is associated. * **LayerId** *(string) --* The ID of the layer to which the instance is attached. * **VpcId** *(string) --* The VPC ID. * **AvailabilityZones** *(list) --* A list of Availability Zones. * *(string) --* * **SubnetIds** *(list) --* A list of subnet IDs, if the stack is running in a VPC. * *(string) --* * **Ec2InstanceIds** *(list) --* A list of the EC2 instances for which the Elastic Load Balancing instance is managing traffic. * *(string) --* **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / associate_elastic_ip associate_elastic_ip ******************** OpsWorks.Client.associate_elastic_ip(**kwargs) Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.associate_elastic_ip( ElasticIp='string', InstanceId='string' ) Parameters: * **ElasticIp** (*string*) -- **[REQUIRED]** The Elastic IP address. * **InstanceId** (*string*) -- The instance ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / get_waiter get_waiter ********** OpsWorks.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" OpsWorks / Client / assign_instance assign_instance *************** OpsWorks.Client.assign_instance(**kwargs) Assign a registered instance to a layer. * You can assign registered on-premises instances to any layer type. * You can assign registered Amazon EC2 instances only to custom layers. * You cannot use this action with instances that were created with OpsWorks Stacks. **Required Permissions**: To use this action, an Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.assign_instance( InstanceId='string', LayerIds=[ 'string', ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The instance ID. * **LayerIds** (*list*) -- **[REQUIRED]** The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer. * *(string) --* Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / set_time_based_auto_scaling set_time_based_auto_scaling *************************** OpsWorks.Client.set_time_based_auto_scaling(**kwargs) Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.set_time_based_auto_scaling( InstanceId='string', AutoScalingSchedule={ 'Monday': { 'string': 'string' }, 'Tuesday': { 'string': 'string' }, 'Wednesday': { 'string': 'string' }, 'Thursday': { 'string': 'string' }, 'Friday': { 'string': 'string' }, 'Saturday': { 'string': 'string' }, 'Sunday': { 'string': 'string' } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The instance ID. * **AutoScalingSchedule** (*dict*) -- An "AutoScalingSchedule" with the instance schedule. * **Monday** *(dict) --* The schedule for Monday. * *(string) --* * *(string) --* * **Tuesday** *(dict) --* The schedule for Tuesday. * *(string) --* * *(string) --* * **Wednesday** *(dict) --* The schedule for Wednesday. * *(string) --* * *(string) --* * **Thursday** *(dict) --* The schedule for Thursday. * *(string) --* * *(string) --* * **Friday** *(dict) --* The schedule for Friday. * *(string) --* * *(string) --* * **Saturday** *(dict) --* The schedule for Saturday. * *(string) --* * *(string) --* * **Sunday** *(dict) --* The schedule for Sunday. * *(string) --* * *(string) --* Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / stop_stack stop_stack ********** OpsWorks.Client.stop_stack(**kwargs) Stops a specified stack. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.stop_stack( StackId='string' ) Parameters: **StackId** (*string*) -- **[REQUIRED]** The stack ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / register_rds_db_instance register_rds_db_instance ************************ OpsWorks.Client.register_rds_db_instance(**kwargs) Registers an Amazon RDS instance with a stack. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.register_rds_db_instance( StackId='string', RdsDbInstanceArn='string', DbUser='string', DbPassword='string' ) Parameters: * **StackId** (*string*) -- **[REQUIRED]** The stack ID. * **RdsDbInstanceArn** (*string*) -- **[REQUIRED]** The Amazon RDS instance's ARN. * **DbUser** (*string*) -- **[REQUIRED]** The database's master user name. * **DbPassword** (*string*) -- **[REQUIRED]** The database password. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_raid_arrays describe_raid_arrays ******************** OpsWorks.Client.describe_raid_arrays(**kwargs) Describe an instance's RAID arrays. Note: This call accepts only one resource-identifying parameter. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_raid_arrays( InstanceId='string', StackId='string', RaidArrayIds=[ 'string', ] ) Parameters: * **InstanceId** (*string*) -- The instance ID. If you use this parameter, "DescribeRaidArrays" returns descriptions of the RAID arrays associated with the specified instance. * **StackId** (*string*) -- The stack ID. * **RaidArrayIds** (*list*) -- An array of RAID array IDs. If you use this parameter, "DescribeRaidArrays" returns descriptions of the specified arrays. Otherwise, it returns a description of every array. * *(string) --* Return type: dict Returns: **Response Syntax** { 'RaidArrays': [ { 'RaidArrayId': 'string', 'InstanceId': 'string', 'Name': 'string', 'RaidLevel': 123, 'NumberOfDisks': 123, 'Size': 123, 'Device': 'string', 'MountPoint': 'string', 'AvailabilityZone': 'string', 'CreatedAt': 'string', 'StackId': 'string', 'VolumeType': 'string', 'Iops': 123 }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeRaidArrays" request. * **RaidArrays** *(list) --* A "RaidArrays" object that describes the specified RAID arrays. * *(dict) --* Describes an instance's RAID array. * **RaidArrayId** *(string) --* The array ID. * **InstanceId** *(string) --* The instance ID. * **Name** *(string) --* The array name. * **RaidLevel** *(integer) --* The RAID level. * **NumberOfDisks** *(integer) --* The number of disks in the array. * **Size** *(integer) --* The array's size. * **Device** *(string) --* The array's Linux device. For example /dev/mdadm0. * **MountPoint** *(string) --* The array's mount point. * **AvailabilityZone** *(string) --* The array's Availability Zone. For more information, see Regions and Endpoints. * **CreatedAt** *(string) --* When the RAID array was created. * **StackId** *(string) --* The stack ID. * **VolumeType** *(string) --* The volume type, standard or PIOPS. * **Iops** *(integer) --* For PIOPS volumes, the IOPS per disk. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / update_layer update_layer ************ OpsWorks.Client.update_layer(**kwargs) Updates a specified layer. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.update_layer( LayerId='string', Name='string', Shortname='string', Attributes={ 'string': 'string' }, CloudWatchLogsConfiguration={ 'Enabled': True|False, 'LogStreams': [ { 'LogGroupName': 'string', 'DatetimeFormat': 'string', 'TimeZone': 'LOCAL'|'UTC', 'File': 'string', 'FileFingerprintLines': 'string', 'MultiLineStartPattern': 'string', 'InitialPosition': 'start_of_file'|'end_of_file', 'Encoding': 'ascii'|'big5'|'big5hkscs'|'cp037'|'cp424'|'cp437'|'cp500'|'cp720'|'cp737'|'cp775'|'cp850'|'cp852'|'cp855'|'cp856'|'cp857'|'cp858'|'cp860'|'cp861'|'cp862'|'cp863'|'cp864'|'cp865'|'cp866'|'cp869'|'cp874'|'cp875'|'cp932'|'cp949'|'cp950'|'cp1006'|'cp1026'|'cp1140'|'cp1250'|'cp1251'|'cp1252'|'cp1253'|'cp1254'|'cp1255'|'cp1256'|'cp1257'|'cp1258'|'euc_jp'|'euc_jis_2004'|'euc_jisx0213'|'euc_kr'|'gb2312'|'gbk'|'gb18030'|'hz'|'iso2022_jp'|'iso2022_jp_1'|'iso2022_jp_2'|'iso2022_jp_2004'|'iso2022_jp_3'|'iso2022_jp_ext'|'iso2022_kr'|'latin_1'|'iso8859_2'|'iso8859_3'|'iso8859_4'|'iso8859_5'|'iso8859_6'|'iso8859_7'|'iso8859_8'|'iso8859_9'|'iso8859_10'|'iso8859_13'|'iso8859_14'|'iso8859_15'|'iso8859_16'|'johab'|'koi8_r'|'koi8_u'|'mac_cyrillic'|'mac_greek'|'mac_iceland'|'mac_latin2'|'mac_roman'|'mac_turkish'|'ptcp154'|'shift_jis'|'shift_jis_2004'|'shift_jisx0213'|'utf_32'|'utf_32_be'|'utf_32_le'|'utf_16'|'utf_16_be'|'utf_16_le'|'utf_7'|'utf_8'|'utf_8_sig', 'BufferDuration': 123, 'BatchCount': 123, 'BatchSize': 123 }, ] }, CustomInstanceProfileArn='string', CustomJson='string', CustomSecurityGroupIds=[ 'string', ], Packages=[ 'string', ], VolumeConfigurations=[ { 'MountPoint': 'string', 'RaidLevel': 123, 'NumberOfDisks': 123, 'Size': 123, 'VolumeType': 'string', 'Iops': 123, 'Encrypted': True|False }, ], EnableAutoHealing=True|False, AutoAssignElasticIps=True|False, AutoAssignPublicIps=True|False, CustomRecipes={ 'Setup': [ 'string', ], 'Configure': [ 'string', ], 'Deploy': [ 'string', ], 'Undeploy': [ 'string', ], 'Shutdown': [ 'string', ] }, InstallUpdatesOnBoot=True|False, UseEbsOptimizedInstances=True|False, LifecycleEventConfiguration={ 'Shutdown': { 'ExecutionTimeout': 123, 'DelayUntilElbConnectionsDrained': True|False } } ) Parameters: * **LayerId** (*string*) -- **[REQUIRED]** The layer ID. * **Name** (*string*) -- The layer name, which is used by the console. Layer names can be a maximum of 32 characters. * **Shortname** (*string*) -- For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 32 characters and must be in the following format: /A[a-z0-9-_.]+Z/. Built-in layer short names are defined by OpsWorks Stacks. For more information, see the Layer reference in the OpsWorks User Guide. * **Attributes** (*dict*) -- One or more user-defined key/value pairs to be added to the stack attributes. * *(string) --* * *(string) --* * **CloudWatchLogsConfiguration** (*dict*) -- Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream. * **Enabled** *(boolean) --* Whether CloudWatch Logs is enabled for a layer. * **LogStreams** *(list) --* A list of configuration options for CloudWatch Logs. * *(dict) --* Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference. * **LogGroupName** *(string) --* Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period). * **DatetimeFormat** *(string) --* Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference. * **TimeZone** *(string) --* Specifies the time zone of log event time stamps. * **File** *(string) --* Specifies log files that you want to push to CloudWatch Logs. "File" can point to a specific file or multiple files (by using wild card characters such as "/var/log/system.log*"). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as "access_log.2014-06-01-01", "access_log.2014-06-01-02", and so on by using a pattern like "access_log.*". Don't use a wildcard to match multiple file types, such as "access_log_80" and "access_log_443". To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group. Zipped files are not supported. * **FileFingerprintLines** *(string) --* Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available. * **MultiLineStartPattern** *(string) --* Specifies the pattern for identifying the start of a log message. * **InitialPosition** *(string) --* Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream. * **Encoding** *(string) --* Specifies the encoding of the log file so that the file can be read correctly. The default is "utf_8". Encodings supported by Python "codecs.decode()" can be used here. * **BufferDuration** *(integer) --* Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms. * **BatchCount** *(integer) --* Specifies the max number of log events in a batch, up to 10000. The default value is 1000. * **BatchSize** *(integer) --* Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. * **CustomInstanceProfileArn** (*string*) -- The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers. * **CustomJson** (*string*) -- A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. * **CustomSecurityGroupIds** (*list*) -- An array containing the layer's custom security group IDs. * *(string) --* * **Packages** (*list*) -- An array of "Package" objects that describe the layer's packages. * *(string) --* * **VolumeConfigurations** (*list*) -- A "VolumeConfigurations" object that describes the layer's Amazon EBS volumes. * *(dict) --* Describes an Amazon EBS volume configuration. * **MountPoint** *(string) --* **[REQUIRED]** The volume mount point. For example "/dev/sdh". * **RaidLevel** *(integer) --* The volume RAID level. * **NumberOfDisks** *(integer) --* **[REQUIRED]** The number of disks in the volume. * **Size** *(integer) --* **[REQUIRED]** The volume size. * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS Volume Types. * "standard" - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB. * "io1" - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB. * "gp2" - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB. * "st1" - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * "sc1" - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * **Iops** *(integer) --* For PIOPS volumes, the IOPS per disk. * **Encrypted** *(boolean) --* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption. * **EnableAutoHealing** (*boolean*) -- Whether to disable auto healing for the layer. * **AutoAssignElasticIps** (*boolean*) -- Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer. * **AutoAssignPublicIps** (*boolean*) -- For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer. * **CustomRecipes** (*dict*) -- A "LayerCustomRecipes" object that specifies the layer's custom recipes. * **Setup** *(list) --* An array of custom recipe names to be run following a "setup" event. * *(string) --* * **Configure** *(list) --* An array of custom recipe names to be run following a "configure" event. * *(string) --* * **Deploy** *(list) --* An array of custom recipe names to be run following a "deploy" event. * *(string) --* * **Undeploy** *(list) --* An array of custom recipe names to be run following a "undeploy" event. * *(string) --* * **Shutdown** *(list) --* An array of custom recipe names to be run following a "shutdown" event. * *(string) --* * **InstallUpdatesOnBoot** (*boolean*) -- Whether to install operating system and package updates when the instance boots. The default value is "true". To control when updates are installed, set this value to "false". You must then update your instances manually by using CreateDeployment to run the "update_dependencies" stack command or manually running "yum" (Amazon Linux) or "apt-get" (Ubuntu) on the instances. Note: We strongly recommend using the default value of "true", to ensure that your instances have the latest security updates. * **UseEbsOptimizedInstances** (*boolean*) -- Whether to use Amazon EBS-optimized instances. * **LifecycleEventConfiguration** (*dict*) -- * **Shutdown** *(dict) --* A "ShutdownEventConfiguration" object that specifies the Shutdown event configuration. * **ExecutionTimeout** *(integer) --* The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before shutting down an instance. * **DelayUntilElbConnectionsDrained** *(boolean) --* Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / register_ecs_cluster register_ecs_cluster ******************** OpsWorks.Client.register_ecs_cluster(**kwargs) Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.register_ecs_cluster( EcsClusterArn='string', StackId='string' ) Parameters: * **EcsClusterArn** (*string*) -- **[REQUIRED]** The cluster's ARN. * **StackId** (*string*) -- **[REQUIRED]** The stack ID. Return type: dict Returns: **Response Syntax** { 'EcsClusterArn': 'string' } **Response Structure** * *(dict) --* Contains the response to a "RegisterEcsCluster" request. * **EcsClusterArn** *(string) --* The cluster's ARN. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / update_instance update_instance *************** OpsWorks.Client.update_instance(**kwargs) Updates a specified instance. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.update_instance( InstanceId='string', LayerIds=[ 'string', ], InstanceType='string', AutoScalingType='load'|'timer', Hostname='string', Os='string', AmiId='string', SshKeyName='string', Architecture='x86_64'|'i386', InstallUpdatesOnBoot=True|False, EbsOptimized=True|False, AgentVersion='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The instance ID. * **LayerIds** (*list*) -- The instance's layer IDs. * *(string) --* * **InstanceType** (*string*) -- The instance type, such as "t2.micro". For a list of supported instance types, open the stack in the console, choose **Instances**, and choose **+ Instance**. The **Size** list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the **API Name** column of the **Available Instance Types** table. * **AutoScalingType** (*string*) -- For load-based or time-based instances, the type. Windows stacks can use only time-based instances. * **Hostname** (*string*) -- The instance host name. The following are character limits for instance host names. * Linux-based instances: 63 characters * Windows-based instances: 15 characters * **Os** (*string*) -- The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI. * A supported Linux operating system: An Amazon Linux version, such as "Amazon Linux 2", "Amazon Linux 2018.03", "Amazon Linux 2017.09", "Amazon Linux 2017.03", "Amazon Linux 2016.09", "Amazon Linux 2016.03", "Amazon Linux 2015.09", or "Amazon Linux 2015.03". * A supported Ubuntu operating system, such as "Ubuntu 18.04 LTS", "Ubuntu 16.04 LTS", "Ubuntu 14.04 LTS", or "Ubuntu 12.04 LTS". * "CentOS Linux 7" * "Red Hat Enterprise Linux 7" * A supported Windows operating system, such as "Microsoft Windows Server 2012 R2 Base", "Microsoft Windows Server 2012 R2 with SQL Server Express", "Microsoft Windows Server 2012 R2 with SQL Server Standard", or "Microsoft Windows Server 2012 R2 with SQL Server Web". Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems. The default option is the current Amazon Linux version. If you set this parameter to "Custom", you must use the AmiId parameter to specify the custom AMI that you want to use. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs. Note: You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux. * **AmiId** (*string*) -- The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs. * **SshKeyName** (*string*) -- The instance's Amazon EC2 key name. * **Architecture** (*string*) -- The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types. * **InstallUpdatesOnBoot** (*boolean*) -- Whether to install operating system and package updates when the instance boots. The default value is "true". To control when updates are installed, set this value to "false". You must then update your instances manually by using CreateDeployment to run the "update_dependencies" stack command or by manually running "yum" (Amazon Linux) or "apt- get" (Ubuntu) on the instances. Note: We strongly recommend using the default value of "true", to ensure that your instances have the latest security updates. * **EbsOptimized** (*boolean*) -- This property cannot be updated. * **AgentVersion** (*string*) -- The default OpsWorks Stacks agent version. You have the following options: * "INHERIT" - Use the stack's default agent version setting. * *version_number* - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. OpsWorks Stacks installs that version on the instance. The default setting is "INHERIT". To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / create_app create_app ********** OpsWorks.Client.create_app(**kwargs) Creates an app for a specified stack. For more information, see Creating Apps. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.create_app( StackId='string', Shortname='string', Name='string', Description='string', DataSources=[ { 'Type': 'string', 'Arn': 'string', 'DatabaseName': 'string' }, ], Type='aws-flow-ruby'|'java'|'rails'|'php'|'nodejs'|'static'|'other', AppSource={ 'Type': 'git'|'svn'|'archive'|'s3', 'Url': 'string', 'Username': 'string', 'Password': 'string', 'SshKey': 'string', 'Revision': 'string' }, Domains=[ 'string', ], EnableSsl=True|False, SslConfiguration={ 'Certificate': 'string', 'PrivateKey': 'string', 'Chain': 'string' }, Attributes={ 'string': 'string' }, Environment=[ { 'Key': 'string', 'Value': 'string', 'Secure': True|False }, ] ) Parameters: * **StackId** (*string*) -- **[REQUIRED]** The stack ID. * **Shortname** (*string*) -- The app's short name. * **Name** (*string*) -- **[REQUIRED]** The app name. * **Description** (*string*) -- A description of the app. * **DataSources** (*list*) -- The app's data source. * *(dict) --* Describes an app's data source. * **Type** *(string) --* The data source's type, "AutoSelectOpsworksMysqlInstance", "OpsworksMysqlInstance", "RdsDbInstance", or "None". * **Arn** *(string) --* The data source's ARN. * **DatabaseName** *(string) --* The database name. * **Type** (*string*) -- **[REQUIRED]** The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify "other". * **AppSource** (*dict*) -- A "Source" object that specifies the app repository. * **Type** *(string) --* The repository type. * **Url** *(string) --* The source URL. The following is an example of an Amazon S3 source URL: "https://s3.amazonaws.com/opsworks-demo- bucket/opsworks_cookbook_demo.tar.gz". * **Username** *(string) --* This parameter depends on the repository type. * For Amazon S3 bundles, set "Username" to the appropriate IAM access key ID. * For HTTP bundles, Git repositories, and Subversion repositories, set "Username" to the user name. * **Password** *(string) --* When included in a request, the parameter depends on the repository type. * For Amazon S3 bundles, set "Password" to the appropriate IAM secret access key. * For HTTP bundles and Subversion repositories, set "Password" to the password. For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access- keys-best-practices.html. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **SshKey** *(string) --* In requests, the repository's SSH key. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **Revision** *(string) --* The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. * **Domains** (*list*) -- The app virtual host settings, with multiple domains separated by commas. For example: "'www.example.com, example.com'" * *(string) --* * **EnableSsl** (*boolean*) -- Whether to enable SSL for the app. * **SslConfiguration** (*dict*) -- An "SslConfiguration" object with the SSL configuration. * **Certificate** *(string) --* **[REQUIRED]** The contents of the certificate's domain.crt file. * **PrivateKey** *(string) --* **[REQUIRED]** The private key; the contents of the certificate's domain.kex file. * **Chain** *(string) --* Optional. Can be used to specify an intermediate certificate authority key or client authentication. * **Attributes** (*dict*) -- One or more user-defined key/value pairs to be added to the stack attributes. * *(string) --* * *(string) --* * **Environment** (*list*) -- An array of "EnvironmentVariable" objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables. There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)." Note: If you have specified one or more environment variables, you cannot modify the stack's Chef version. * *(dict) --* Represents an app's environment variable. * **Key** *(string) --* **[REQUIRED]** (Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore. * **Value** *(string) --* **[REQUIRED]** (Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable. * **Secure** *(boolean) --* (Optional) Whether the variable's value is returned by the DescribeApps action. To hide an environment variable's value, set "Secure" to "true". "DescribeApps" returns "*****FILTERED*****" instead of the actual value. The default value for "Secure" is "false". Return type: dict Returns: **Response Syntax** { 'AppId': 'string' } **Response Structure** * *(dict) --* Contains the response to a "CreateApp" request. * **AppId** *(string) --* The app ID. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / deregister_volume deregister_volume ***************** OpsWorks.Client.deregister_volume(**kwargs) Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.deregister_volume( VolumeId='string' ) Parameters: **VolumeId** (*string*) -- **[REQUIRED]** The OpsWorks Stacks volume ID, which is the GUID that OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_permissions describe_permissions ******************** OpsWorks.Client.describe_permissions(**kwargs) Describes the permissions for a specified stack. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_permissions( IamUserArn='string', StackId='string' ) Parameters: * **IamUserArn** (*string*) -- The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using Identifiers. * **StackId** (*string*) -- The stack ID. Return type: dict Returns: **Response Syntax** { 'Permissions': [ { 'StackId': 'string', 'IamUserArn': 'string', 'AllowSsh': True|False, 'AllowSudo': True|False, 'Level': 'string' }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribePermissions" request. * **Permissions** *(list) --* An array of "Permission" objects that describe the stack permissions. * If the request object contains only a stack ID, the array contains a "Permission" object with permissions for each of the stack IAM ARNs. * If the request object contains only an IAM ARN, the array contains a "Permission" object with permissions for each of the user's stack IDs. * If the request contains a stack ID and an IAM ARN, the array contains a single "Permission" object with permissions for the specified stack and IAM ARN. * *(dict) --* Describes stack or user permissions. * **StackId** *(string) --* A stack ID. * **IamUserArn** *(string) --* The Amazon Resource Name (ARN) for an Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers. * **AllowSsh** *(boolean) --* Whether the user can use SSH. * **AllowSudo** *(boolean) --* Whether the user can use **sudo**. * **Level** *(string) --* The user's permission level, which must be the following: * "deny" * "show" * "deploy" * "manage" * "iam_only" For more information on the permissions associated with these levels, see Managing User Permissions **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_agent_versions describe_agent_versions *********************** OpsWorks.Client.describe_agent_versions(**kwargs) Describes the available OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. "DescribeAgentVersions" returns a list of available agent versions for the specified stack or configuration manager. See also: AWS API Documentation **Request Syntax** response = client.describe_agent_versions( StackId='string', ConfigurationManager={ 'Name': 'string', 'Version': 'string' } ) Parameters: * **StackId** (*string*) -- The stack ID. * **ConfigurationManager** (*dict*) -- The configuration manager. * **Name** *(string) --* The name. This parameter must be set to "Chef". * **Version** *(string) --* The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12. Return type: dict Returns: **Response Syntax** { 'AgentVersions': [ { 'Version': 'string', 'ConfigurationManager': { 'Name': 'string', 'Version': 'string' } }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeAgentVersions" request. * **AgentVersions** *(list) --* The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console. * *(dict) --* Describes an agent version. * **Version** *(string) --* The agent version. * **ConfigurationManager** *(dict) --* The configuration manager. * **Name** *(string) --* The name. This parameter must be set to "Chef". * **Version** *(string) --* The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / attach_elastic_load_balancer attach_elastic_load_balancer **************************** OpsWorks.Client.attach_elastic_load_balancer(**kwargs) Attaches an Elastic Load Balancing load balancer to a specified layer. OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with OpsWorks Stacks. For more information, see Elastic Load Balancing. Note: You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see the Elastic Load Balancing Developer Guide. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.attach_elastic_load_balancer( ElasticLoadBalancerName='string', LayerId='string' ) Parameters: * **ElasticLoadBalancerName** (*string*) -- **[REQUIRED]** The Elastic Load Balancing instance's name. * **LayerId** (*string*) -- **[REQUIRED]** The ID of the layer to which the Elastic Load Balancing instance is to be attached. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / set_permission set_permission ************** OpsWorks.Client.set_permission(**kwargs) Specifies a user's permissions. For more information, see Security and Permissions. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.set_permission( StackId='string', IamUserArn='string', AllowSsh=True|False, AllowSudo=True|False, Level='string' ) Parameters: * **StackId** (*string*) -- **[REQUIRED]** The stack ID. * **IamUserArn** (*string*) -- **[REQUIRED]** The user's IAM ARN. This can also be a federated user's ARN. * **AllowSsh** (*boolean*) -- The user is allowed to use SSH to communicate with the instance. * **AllowSudo** (*boolean*) -- The user is allowed to use **sudo** to elevate privileges. * **Level** (*string*) -- The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level. * "deny" * "show" * "deploy" * "manage" * "iam_only" For more information about the permissions associated with these levels, see Managing User Permissions. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_rds_db_instances describe_rds_db_instances ************************* OpsWorks.Client.describe_rds_db_instances(**kwargs) Describes Amazon RDS instances. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. See also: AWS API Documentation **Request Syntax** response = client.describe_rds_db_instances( StackId='string', RdsDbInstanceArns=[ 'string', ] ) Parameters: * **StackId** (*string*) -- **[REQUIRED]** The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances. * **RdsDbInstanceArns** (*list*) -- An array containing the ARNs of the instances to be described. * *(string) --* Return type: dict Returns: **Response Syntax** { 'RdsDbInstances': [ { 'RdsDbInstanceArn': 'string', 'DbInstanceIdentifier': 'string', 'DbUser': 'string', 'DbPassword': 'string', 'Region': 'string', 'Address': 'string', 'Engine': 'string', 'StackId': 'string', 'MissingOnRds': True|False }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeRdsDbInstances" request. * **RdsDbInstances** *(list) --* An a array of "RdsDbInstance" objects that describe the instances. * *(dict) --* Describes an Amazon RDS instance. * **RdsDbInstanceArn** *(string) --* The instance's ARN. * **DbInstanceIdentifier** *(string) --* The database instance identifier. * **DbUser** *(string) --* The master user name. * **DbPassword** *(string) --* OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **Region** *(string) --* The instance's Amazon Web Services Region. * **Address** *(string) --* The instance's address. * **Engine** *(string) --* The instance's database engine. * **StackId** *(string) --* The ID of the stack with which the instance is registered. * **MissingOnRds** *(boolean) --* Set to "true" if OpsWorks Stacks is unable to discover the Amazon RDS instance. OpsWorks Stacks attempts to discover the instance only once. If this value is set to "true", you must deregister the instance, and then register it again. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / register_volume register_volume *************** OpsWorks.Client.register_volume(**kwargs) Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.register_volume( Ec2VolumeId='string', StackId='string' ) Parameters: * **Ec2VolumeId** (*string*) -- The Amazon EBS volume ID. * **StackId** (*string*) -- **[REQUIRED]** The stack ID. Return type: dict Returns: **Response Syntax** { 'VolumeId': 'string' } **Response Structure** * *(dict) --* Contains the response to a "RegisterVolume" request. * **VolumeId** *(string) --* The volume ID. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_time_based_auto_scaling describe_time_based_auto_scaling ******************************** OpsWorks.Client.describe_time_based_auto_scaling(**kwargs) Describes time-based auto scaling configurations for specified instances. Note: You must specify at least one of the parameters. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_time_based_auto_scaling( InstanceIds=[ 'string', ] ) Parameters: **InstanceIds** (*list*) -- **[REQUIRED]** An array of instance IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'TimeBasedAutoScalingConfigurations': [ { 'InstanceId': 'string', 'AutoScalingSchedule': { 'Monday': { 'string': 'string' }, 'Tuesday': { 'string': 'string' }, 'Wednesday': { 'string': 'string' }, 'Thursday': { 'string': 'string' }, 'Friday': { 'string': 'string' }, 'Saturday': { 'string': 'string' }, 'Sunday': { 'string': 'string' } } }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeTimeBasedAutoScaling" request. * **TimeBasedAutoScalingConfigurations** *(list) --* An array of "TimeBasedAutoScalingConfiguration" objects that describe the configuration for the specified instances. * *(dict) --* Describes an instance's time-based auto scaling configuration. * **InstanceId** *(string) --* The instance ID. * **AutoScalingSchedule** *(dict) --* A "WeeklyAutoScalingSchedule" object with the instance schedule. * **Monday** *(dict) --* The schedule for Monday. * *(string) --* * *(string) --* * **Tuesday** *(dict) --* The schedule for Tuesday. * *(string) --* * *(string) --* * **Wednesday** *(dict) --* The schedule for Wednesday. * *(string) --* * *(string) --* * **Thursday** *(dict) --* The schedule for Thursday. * *(string) --* * *(string) --* * **Friday** *(dict) --* The schedule for Friday. * *(string) --* * *(string) --* * **Saturday** *(dict) --* The schedule for Saturday. * *(string) --* * *(string) --* * **Sunday** *(dict) --* The schedule for Sunday. * *(string) --* * *(string) --* **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / register_instance register_instance ***************** OpsWorks.Client.register_instance(**kwargs) Registers instances that were created outside of OpsWorks Stacks with a specified stack. Note: We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the OpsWorks Stacks agent on the instance, and registering the instance with the stack. "RegisterInstance" handles only the second step. You should instead use the CLI "register" command, which performs the entire registration operation. For more information, see Registering an Instance with an OpsWorks Stacks Stack. Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.register_instance( StackId='string', Hostname='string', PublicIp='string', PrivateIp='string', RsaPublicKey='string', RsaPublicKeyFingerprint='string', InstanceIdentity={ 'Document': 'string', 'Signature': 'string' } ) Parameters: * **StackId** (*string*) -- **[REQUIRED]** The ID of the stack that the instance is to be registered with. * **Hostname** (*string*) -- The instance's host name. The following are character limits for instance host names. * Linux-based instances: 63 characters * Windows-based instances: 15 characters * **PublicIp** (*string*) -- The instance's public IP address. * **PrivateIp** (*string*) -- The instance's private IP address. * **RsaPublicKey** (*string*) -- The instances public RSA key. This key is used to encrypt communication between the instance and the service. * **RsaPublicKeyFingerprint** (*string*) -- The instances public RSA key fingerprint. * **InstanceIdentity** (*dict*) -- An InstanceIdentity object that contains the instance's identity. * **Document** *(string) --* A JSON document that contains the metadata. * **Signature** *(string) --* A signature that can be used to verify the document's accuracy and authenticity. Return type: dict Returns: **Response Syntax** { 'InstanceId': 'string' } **Response Structure** * *(dict) --* Contains the response to a "RegisterInstanceResult" request. * **InstanceId** *(string) --* The registered instance's OpsWorks Stacks ID. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_stack_summary describe_stack_summary ********************** OpsWorks.Client.describe_stack_summary(**kwargs) Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as "running_setup" or "online". **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_stack_summary( StackId='string' ) Parameters: **StackId** (*string*) -- **[REQUIRED]** The stack ID. Return type: dict Returns: **Response Syntax** { 'StackSummary': { 'StackId': 'string', 'Name': 'string', 'Arn': 'string', 'LayersCount': 123, 'AppsCount': 123, 'InstancesCount': { 'Assigning': 123, 'Booting': 123, 'ConnectionLost': 123, 'Deregistering': 123, 'Online': 123, 'Pending': 123, 'Rebooting': 123, 'Registered': 123, 'Registering': 123, 'Requested': 123, 'RunningSetup': 123, 'SetupFailed': 123, 'ShuttingDown': 123, 'StartFailed': 123, 'StopFailed': 123, 'Stopped': 123, 'Stopping': 123, 'Terminated': 123, 'Terminating': 123, 'Unassigning': 123 } } } **Response Structure** * *(dict) --* Contains the response to a "DescribeStackSummary" request. * **StackSummary** *(dict) --* A "StackSummary" object that contains the results. * **StackId** *(string) --* The stack ID. * **Name** *(string) --* The stack name. * **Arn** *(string) --* The stack's ARN. * **LayersCount** *(integer) --* The number of layers. * **AppsCount** *(integer) --* The number of apps. * **InstancesCount** *(dict) --* An "InstancesCount" object with the number of instances in each status. * **Assigning** *(integer) --* The number of instances in the Assigning state. * **Booting** *(integer) --* The number of instances with "booting" status. * **ConnectionLost** *(integer) --* The number of instances with "connection_lost" status. * **Deregistering** *(integer) --* The number of instances in the Deregistering state. * **Online** *(integer) --* The number of instances with "online" status. * **Pending** *(integer) --* The number of instances with "pending" status. * **Rebooting** *(integer) --* The number of instances with "rebooting" status. * **Registered** *(integer) --* The number of instances in the Registered state. * **Registering** *(integer) --* The number of instances in the Registering state. * **Requested** *(integer) --* The number of instances with "requested" status. * **RunningSetup** *(integer) --* The number of instances with "running_setup" status. * **SetupFailed** *(integer) --* The number of instances with "setup_failed" status. * **ShuttingDown** *(integer) --* The number of instances with "shutting_down" status. * **StartFailed** *(integer) --* The number of instances with "start_failed" status. * **StopFailed** *(integer) --* The number of instances with "stop_failed" status. * **Stopped** *(integer) --* The number of instances with "stopped" status. * **Stopping** *(integer) --* The number of instances with "stopping" status. * **Terminated** *(integer) --* The number of instances with "terminated" status. * **Terminating** *(integer) --* The number of instances with "terminating" status. * **Unassigning** *(integer) --* The number of instances in the Unassigning state. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / update_rds_db_instance update_rds_db_instance ********************** OpsWorks.Client.update_rds_db_instance(**kwargs) Updates an Amazon RDS instance. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.update_rds_db_instance( RdsDbInstanceArn='string', DbUser='string', DbPassword='string' ) Parameters: * **RdsDbInstanceArn** (*string*) -- **[REQUIRED]** The Amazon RDS instance's ARN. * **DbUser** (*string*) -- The master user name. * **DbPassword** (*string*) -- The database password. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / disassociate_elastic_ip disassociate_elastic_ip *********************** OpsWorks.Client.disassociate_elastic_ip(**kwargs) Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.disassociate_elastic_ip( ElasticIp='string' ) Parameters: **ElasticIp** (*string*) -- **[REQUIRED]** The Elastic IP address. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_stack_provisioning_parameters describe_stack_provisioning_parameters ************************************** OpsWorks.Client.describe_stack_provisioning_parameters(**kwargs) Requests a description of a stack's provisioning parameters. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_stack_provisioning_parameters( StackId='string' ) Parameters: **StackId** (*string*) -- **[REQUIRED]** The stack ID. Return type: dict Returns: **Response Syntax** { 'AgentInstallerUrl': 'string', 'Parameters': { 'string': 'string' } } **Response Structure** * *(dict) --* Contains the response to a "DescribeStackProvisioningParameters" request. * **AgentInstallerUrl** *(string) --* The OpsWorks Stacks agent installer's URL. * **Parameters** *(dict) --* An embedded object that contains the provisioning parameters. * *(string) --* * *(string) --* **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / create_user_profile create_user_profile ******************* OpsWorks.Client.create_user_profile(**kwargs) Creates a new user profile. **Required Permissions**: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.create_user_profile( IamUserArn='string', SshUsername='string', SshPublicKey='string', AllowSelfManagement=True|False ) Parameters: * **IamUserArn** (*string*) -- **[REQUIRED]** The user's IAM ARN; this can also be a federated user's ARN. * **SshUsername** (*string*) -- The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, OpsWorks Stacks removes them. For example, "my.name" is changed to "myname". If you do not specify an SSH user name, OpsWorks Stacks generates one from the IAM user name. * **SshPublicKey** (*string*) -- The user's public SSH key. * **AllowSelfManagement** (*boolean*) -- Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key. Return type: dict Returns: **Response Syntax** { 'IamUserArn': 'string' } **Response Structure** * *(dict) --* Contains the response to a "CreateUserProfile" request. * **IamUserArn** *(string) --* The user's IAM ARN. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" OpsWorks / Client / deregister_rds_db_instance deregister_rds_db_instance ************************** OpsWorks.Client.deregister_rds_db_instance(**kwargs) Deregisters an Amazon RDS instance. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.deregister_rds_db_instance( RdsDbInstanceArn='string' ) Parameters: **RdsDbInstanceArn** (*string*) -- **[REQUIRED]** The Amazon RDS instance's ARN. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / update_my_user_profile update_my_user_profile ********************** OpsWorks.Client.update_my_user_profile(**kwargs) Updates a user's SSH public key. **Required Permissions**: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.update_my_user_profile( SshPublicKey='string' ) Parameters: **SshPublicKey** (*string*) -- The user's SSH public key. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" OpsWorks / Client / update_app update_app ********** OpsWorks.Client.update_app(**kwargs) Updates a specified app. **Required Permissions**: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.update_app( AppId='string', Name='string', Description='string', DataSources=[ { 'Type': 'string', 'Arn': 'string', 'DatabaseName': 'string' }, ], Type='aws-flow-ruby'|'java'|'rails'|'php'|'nodejs'|'static'|'other', AppSource={ 'Type': 'git'|'svn'|'archive'|'s3', 'Url': 'string', 'Username': 'string', 'Password': 'string', 'SshKey': 'string', 'Revision': 'string' }, Domains=[ 'string', ], EnableSsl=True|False, SslConfiguration={ 'Certificate': 'string', 'PrivateKey': 'string', 'Chain': 'string' }, Attributes={ 'string': 'string' }, Environment=[ { 'Key': 'string', 'Value': 'string', 'Secure': True|False }, ] ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **Name** (*string*) -- The app name. * **Description** (*string*) -- A description of the app. * **DataSources** (*list*) -- The app's data sources. * *(dict) --* Describes an app's data source. * **Type** *(string) --* The data source's type, "AutoSelectOpsworksMysqlInstance", "OpsworksMysqlInstance", "RdsDbInstance", or "None". * **Arn** *(string) --* The data source's ARN. * **DatabaseName** *(string) --* The database name. * **Type** (*string*) -- The app type. * **AppSource** (*dict*) -- A "Source" object that specifies the app repository. * **Type** *(string) --* The repository type. * **Url** *(string) --* The source URL. The following is an example of an Amazon S3 source URL: "https://s3.amazonaws.com/opsworks-demo- bucket/opsworks_cookbook_demo.tar.gz". * **Username** *(string) --* This parameter depends on the repository type. * For Amazon S3 bundles, set "Username" to the appropriate IAM access key ID. * For HTTP bundles, Git repositories, and Subversion repositories, set "Username" to the user name. * **Password** *(string) --* When included in a request, the parameter depends on the repository type. * For Amazon S3 bundles, set "Password" to the appropriate IAM secret access key. * For HTTP bundles and Subversion repositories, set "Password" to the password. For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access- keys-best-practices.html. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **SshKey** *(string) --* In requests, the repository's SSH key. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **Revision** *(string) --* The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. * **Domains** (*list*) -- The app's virtual host settings, with multiple domains separated by commas. For example: "'www.example.com, example.com'" * *(string) --* * **EnableSsl** (*boolean*) -- Whether SSL is enabled for the app. * **SslConfiguration** (*dict*) -- An "SslConfiguration" object with the SSL configuration. * **Certificate** *(string) --* **[REQUIRED]** The contents of the certificate's domain.crt file. * **PrivateKey** *(string) --* **[REQUIRED]** The private key; the contents of the certificate's domain.kex file. * **Chain** *(string) --* Optional. Can be used to specify an intermediate certificate authority key or client authentication. * **Attributes** (*dict*) -- One or more user-defined key/value pairs to be added to the stack attributes. * *(string) --* * *(string) --* * **Environment** (*list*) -- An array of "EnvironmentVariable" objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see Environment Variables. There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20 KB)." Note: If you have specified one or more environment variables, you cannot modify the stack's Chef version. * *(dict) --* Represents an app's environment variable. * **Key** *(string) --* **[REQUIRED]** (Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore. * **Value** *(string) --* **[REQUIRED]** (Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable. * **Secure** *(boolean) --* (Optional) Whether the variable's value is returned by the DescribeApps action. To hide an environment variable's value, set "Secure" to "true". "DescribeApps" returns "*****FILTERED*****" instead of the actual value. The default value for "Secure" is "false". Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / close close ***** OpsWorks.Client.close() Closes underlying endpoint connections. OpsWorks / Client / deregister_ecs_cluster deregister_ecs_cluster ********************** OpsWorks.Client.deregister_ecs_cluster(**kwargs) Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks- security-users.html. See also: AWS API Documentation **Request Syntax** response = client.deregister_ecs_cluster( EcsClusterArn='string' ) Parameters: **EcsClusterArn** (*string*) -- **[REQUIRED]** The cluster's Amazon Resource Number (ARN). Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / delete_stack delete_stack ************ OpsWorks.Client.delete_stack(**kwargs) Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.delete_stack( StackId='string' ) Parameters: **StackId** (*string*) -- **[REQUIRED]** The stack ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_service_errors describe_service_errors *********************** OpsWorks.Client.describe_service_errors(**kwargs) Describes OpsWorks Stacks service errors. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. See also: AWS API Documentation **Request Syntax** response = client.describe_service_errors( StackId='string', InstanceId='string', ServiceErrorIds=[ 'string', ] ) Parameters: * **StackId** (*string*) -- The stack ID. If you use this parameter, "DescribeServiceErrors" returns descriptions of the errors associated with the specified stack. * **InstanceId** (*string*) -- The instance ID. If you use this parameter, "DescribeServiceErrors" returns descriptions of the errors associated with the specified instance. * **ServiceErrorIds** (*list*) -- An array of service error IDs. If you use this parameter, "DescribeServiceErrors" returns descriptions of the specified errors. Otherwise, it returns a description of every error. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ServiceErrors': [ { 'ServiceErrorId': 'string', 'StackId': 'string', 'InstanceId': 'string', 'Type': 'string', 'Message': 'string', 'CreatedAt': 'string' }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeServiceErrors" request. * **ServiceErrors** *(list) --* An array of "ServiceError" objects that describe the specified service errors. * *(dict) --* Describes an OpsWorks Stacks service error. * **ServiceErrorId** *(string) --* The error ID. * **StackId** *(string) --* The stack ID. * **InstanceId** *(string) --* The instance ID. * **Type** *(string) --* The error type. * **Message** *(string) --* A message that describes the error. * **CreatedAt** *(string) --* When the error occurred. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / delete_instance delete_instance *************** OpsWorks.Client.delete_instance(**kwargs) Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it. For more information, see Deleting Instances. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.delete_instance( InstanceId='string', DeleteElasticIp=True|False, DeleteVolumes=True|False ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The instance ID. * **DeleteElasticIp** (*boolean*) -- Whether to delete the instance Elastic IP address. * **DeleteVolumes** (*boolean*) -- Whether to delete the instance's Amazon EBS volumes. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / create_deployment create_deployment ***************** OpsWorks.Client.create_deployment(**kwargs) Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands. **Required Permissions**: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.create_deployment( StackId='string', AppId='string', InstanceIds=[ 'string', ], LayerIds=[ 'string', ], Command={ 'Name': 'install_dependencies'|'update_dependencies'|'update_custom_cookbooks'|'execute_recipes'|'configure'|'setup'|'deploy'|'rollback'|'start'|'stop'|'restart'|'undeploy', 'Args': { 'string': [ 'string', ] } }, Comment='string', CustomJson='string' ) Parameters: * **StackId** (*string*) -- **[REQUIRED]** The stack ID. * **AppId** (*string*) -- The app ID. This parameter is required for app deployments, but not for other deployment commands. * **InstanceIds** (*list*) -- The instance IDs for the deployment targets. * *(string) --* * **LayerIds** (*list*) -- The layer IDs for the deployment targets. * *(string) --* * **Command** (*dict*) -- **[REQUIRED]** A "DeploymentCommand" object that specifies the deployment command and any associated arguments. * **Name** *(string) --* **[REQUIRED]** Specifies the operation. You can specify only one command. For stacks, the following commands are available: * "execute_recipes": Execute one or more recipes. To specify the recipes, set an "Args" parameter named "recipes" to the list of recipes to be executed. For example, to execute "phpapp::appsetup", set "Args" to "{"recipes":["phpapp::appsetup"]}". * "install_dependencies": Install the stack's dependencies. * "update_custom_cookbooks": Update the stack's custom cookbooks. * "update_dependencies": Update the stack's dependencies. Note: The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing. For apps, the following commands are available: * "deploy": Deploy an app. Ruby on Rails apps have an optional "Args" parameter named "migrate". Set "Args" to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}. * "rollback" Roll the app back to the previous version. When you update an app, OpsWorks Stacks stores the previous version, 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. * **Args** *(dict) --* The arguments of those commands that take arguments. It should be set to a JSON object with the following format: "{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}" The "update_dependencies" command takes two arguments: * "upgrade_os_to" - Specifies the Amazon Linux version that you want instances to run, such as "Amazon Linux 2". You must also set the "allow_reboot" argument to true. * "allow_reboot" - Specifies whether to allow OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to either "true" or "false". The default value is "false". For example, to upgrade an instance to Amazon Linux 2018.03, set "Args" to the following. "{ "upgrade_os_to":["Amazon Linux 2018.03"], "allow_reboot":["true"] }" * *(string) --* * *(list) --* * *(string) --* * **Comment** (*string*) -- A user-defined comment. * **CustomJson** (*string*) -- A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format: ""{\"key1\": \"value1\", \"key2\": \"value2\",...}"" For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON. Return type: dict Returns: **Response Syntax** { 'DeploymentId': 'string' } **Response Structure** * *(dict) --* Contains the response to a "CreateDeployment" request. * **DeploymentId** *(string) --* The deployment ID, which can be used with other requests to identify the deployment. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / reboot_instance reboot_instance *************** OpsWorks.Client.reboot_instance(**kwargs) Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.reboot_instance( InstanceId='string' ) Parameters: **InstanceId** (*string*) -- **[REQUIRED]** The instance ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / stop_instance stop_instance ************* OpsWorks.Client.stop_instance(**kwargs) Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.stop_instance( InstanceId='string', Force=True|False ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The instance ID. * **Force** (*boolean*) -- Specifies whether to force an instance to stop. If the instance's root device type is "ebs", or EBS-backed, adding the "Force" parameter to the "StopInstances" API call disassociates the OpsWorks Stacks instance from EC2, and forces deletion of *only* the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the OpsWorks Stacks instance with a new one. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_apps describe_apps ************* OpsWorks.Client.describe_apps(**kwargs) Requests a description of a specified set of apps. Note: This call accepts only one resource-identifying parameter. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_apps( StackId='string', AppIds=[ 'string', ] ) Parameters: * **StackId** (*string*) -- The app stack ID. If you use this parameter, "DescribeApps" returns a description of the apps in the specified stack. * **AppIds** (*list*) -- An array of app IDs for the apps to be described. If you use this parameter, "DescribeApps" returns a description of the specified apps. Otherwise, it returns a description of every app. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Apps': [ { 'AppId': 'string', 'StackId': 'string', 'Shortname': 'string', 'Name': 'string', 'Description': 'string', 'DataSources': [ { 'Type': 'string', 'Arn': 'string', 'DatabaseName': 'string' }, ], 'Type': 'aws-flow-ruby'|'java'|'rails'|'php'|'nodejs'|'static'|'other', 'AppSource': { 'Type': 'git'|'svn'|'archive'|'s3', 'Url': 'string', 'Username': 'string', 'Password': 'string', 'SshKey': 'string', 'Revision': 'string' }, 'Domains': [ 'string', ], 'EnableSsl': True|False, 'SslConfiguration': { 'Certificate': 'string', 'PrivateKey': 'string', 'Chain': 'string' }, 'Attributes': { 'string': 'string' }, 'CreatedAt': 'string', 'Environment': [ { 'Key': 'string', 'Value': 'string', 'Secure': True|False }, ] }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeApps" request. * **Apps** *(list) --* An array of "App" objects that describe the specified apps. * *(dict) --* A description of the app. * **AppId** *(string) --* The app ID. * **StackId** *(string) --* The app stack ID. * **Shortname** *(string) --* The app's short name. * **Name** *(string) --* The app name. * **Description** *(string) --* A description of the app. * **DataSources** *(list) --* The app's data sources. * *(dict) --* Describes an app's data source. * **Type** *(string) --* The data source's type, "AutoSelectOpsworksMysqlInstance", "OpsworksMysqlInstance", "RdsDbInstance", or "None". * **Arn** *(string) --* The data source's ARN. * **DatabaseName** *(string) --* The database name. * **Type** *(string) --* The app type. * **AppSource** *(dict) --* A "Source" object that describes the app repository. * **Type** *(string) --* The repository type. * **Url** *(string) --* The source URL. The following is an example of an Amazon S3 source URL: "https://s3.amazonaws.com /opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz". * **Username** *(string) --* This parameter depends on the repository type. * For Amazon S3 bundles, set "Username" to the appropriate IAM access key ID. * For HTTP bundles, Git repositories, and Subversion repositories, set "Username" to the user name. * **Password** *(string) --* When included in a request, the parameter depends on the repository type. * For Amazon S3 bundles, set "Password" to the appropriate IAM secret access key. * For HTTP bundles and Subversion repositories, set "Password" to the password. For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws- access-keys-best-practices.html. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **SshKey** *(string) --* In requests, the repository's SSH key. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **Revision** *(string) --* The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. * **Domains** *(list) --* The app vhost settings with multiple domains separated by commas. For example: "'www.example.com, example.com'" * *(string) --* * **EnableSsl** *(boolean) --* Whether to enable SSL for the app. * **SslConfiguration** *(dict) --* An "SslConfiguration" object with the SSL configuration. * **Certificate** *(string) --* The contents of the certificate's domain.crt file. * **PrivateKey** *(string) --* The private key; the contents of the certificate's domain.kex file. * **Chain** *(string) --* Optional. Can be used to specify an intermediate certificate authority key or client authentication. * **Attributes** *(dict) --* The stack attributes. * *(string) --* * *(string) --* * **CreatedAt** *(string) --* When the app was created. * **Environment** *(list) --* An array of "EnvironmentVariable" objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables. Note: There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message. * *(dict) --* Represents an app's environment variable. * **Key** *(string) --* (Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore. * **Value** *(string) --* (Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable. * **Secure** *(boolean) --* (Optional) Whether the variable's value is returned by the DescribeApps action. To hide an environment variable's value, set "Secure" to "true". "DescribeApps" returns "*****FILTERED*****" instead of the actual value. The default value for "Secure" is "false". **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_operating_systems describe_operating_systems ************************** OpsWorks.Client.describe_operating_systems() Describes the operating systems that are supported by OpsWorks Stacks. See also: AWS API Documentation **Request Syntax** response = client.describe_operating_systems() Return type: dict Returns: **Response Syntax** { 'OperatingSystems': [ { 'Name': 'string', 'Id': 'string', 'Type': 'string', 'ConfigurationManagers': [ { 'Name': 'string', 'Version': 'string' }, ], 'ReportedName': 'string', 'ReportedVersion': 'string', 'Supported': True|False }, ] } **Response Structure** * *(dict) --* The response to a "DescribeOperatingSystems" request. * **OperatingSystems** *(list) --* Contains information in response to a "DescribeOperatingSystems" request. * *(dict) --* Describes supported operating systems in OpsWorks Stacks. * **Name** *(string) --* The name of the operating system, such as "Amazon Linux 2". * **Id** *(string) --* The ID of a supported operating system, such as "Amazon Linux 2". * **Type** *(string) --* The type of a supported operating system, either "Linux" or "Windows". * **ConfigurationManagers** *(list) --* Supported configuration manager name and versions for an OpsWorks Stacks operating system. * *(dict) --* A block that contains information about the configuration manager (Chef) and the versions of the configuration manager that are supported for an operating system. * **Name** *(string) --* The name of the configuration manager, which is Chef. * **Version** *(string) --* The versions of the configuration manager that are supported by an operating system. * **ReportedName** *(string) --* A short name for the operating system manufacturer. * **ReportedVersion** *(string) --* The version of the operating system, including the release and edition, if applicable. * **Supported** *(boolean) --* Indicates that an operating system is not supported for new instances. OpsWorks / Client / assign_volume assign_volume ************* OpsWorks.Client.assign_volume(**kwargs) Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling "AssignVolume". For more information, see Resource Management. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.assign_volume( VolumeId='string', InstanceId='string' ) Parameters: * **VolumeId** (*string*) -- **[REQUIRED]** The volume ID. * **InstanceId** (*string*) -- The instance ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / detach_elastic_load_balancer detach_elastic_load_balancer **************************** OpsWorks.Client.detach_elastic_load_balancer(**kwargs) Detaches a specified Elastic Load Balancing instance from its layer. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.detach_elastic_load_balancer( ElasticLoadBalancerName='string', LayerId='string' ) Parameters: * **ElasticLoadBalancerName** (*string*) -- **[REQUIRED]** The Elastic Load Balancing instance's name. * **LayerId** (*string*) -- **[REQUIRED]** The ID of the layer that the Elastic Load Balancing instance is attached to. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_deployments describe_deployments ******************** OpsWorks.Client.describe_deployments(**kwargs) Requests a description of a specified set of deployments. Note: This call accepts only one resource-identifying parameter. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_deployments( StackId='string', AppId='string', DeploymentIds=[ 'string', ] ) Parameters: * **StackId** (*string*) -- The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack. * **AppId** (*string*) -- The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app. * **DeploymentIds** (*list*) -- An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Deployments': [ { 'DeploymentId': 'string', 'StackId': 'string', 'AppId': 'string', 'CreatedAt': 'string', 'CompletedAt': 'string', 'Duration': 123, 'IamUserArn': 'string', 'Comment': 'string', 'Command': { 'Name': 'install_dependencies'|'update_dependencies'|'update_custom_cookbooks'|'execute_recipes'|'configure'|'setup'|'deploy'|'rollback'|'start'|'stop'|'restart'|'undeploy', 'Args': { 'string': [ 'string', ] } }, 'Status': 'string', 'CustomJson': 'string', 'InstanceIds': [ 'string', ] }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeDeployments" request. * **Deployments** *(list) --* An array of "Deployment" objects that describe the deployments. * *(dict) --* Describes a deployment of a stack or app. * **DeploymentId** *(string) --* The deployment ID. * **StackId** *(string) --* The stack ID. * **AppId** *(string) --* The app ID. * **CreatedAt** *(string) --* Date when the deployment was created. * **CompletedAt** *(string) --* Date when the deployment completed. * **Duration** *(integer) --* The deployment duration. * **IamUserArn** *(string) --* The user's IAM ARN. * **Comment** *(string) --* A user-defined comment. * **Command** *(dict) --* Used to specify a stack or deployment command. * **Name** *(string) --* Specifies the operation. You can specify only one command. For stacks, the following commands are available: * "execute_recipes": Execute one or more recipes. To specify the recipes, set an "Args" parameter named "recipes" to the list of recipes to be executed. For example, to execute "phpapp::appsetup", set "Args" to "{"recipes":["phpapp::appsetup"]}". * "install_dependencies": Install the stack's dependencies. * "update_custom_cookbooks": Update the stack's custom cookbooks. * "update_dependencies": Update the stack's dependencies. Note: The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing. For apps, the following commands are available: * "deploy": Deploy an app. Ruby on Rails apps have an optional "Args" parameter named "migrate". Set "Args" to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}. * "rollback" Roll the app back to the previous version. When you update an app, OpsWorks Stacks stores the previous version, 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. * **Args** *(dict) --* The arguments of those commands that take arguments. It should be set to a JSON object with the following format: "{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}" The "update_dependencies" command takes two arguments: * "upgrade_os_to" - Specifies the Amazon Linux version that you want instances to run, such as "Amazon Linux 2". You must also set the "allow_reboot" argument to true. * "allow_reboot" - Specifies whether to allow OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to either "true" or "false". The default value is "false". For example, to upgrade an instance to Amazon Linux 2018.03, set "Args" to the following. "{ "upgrade_os_to":["Amazon Linux 2018.03"], "allow_reboot":["true"] }" * *(string) --* * *(list) --* * *(string) --* * **Status** *(string) --* The deployment status: * running * successful * failed * **CustomJson** *(string) --* A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format: ""{\"key1\": \"value1\", \"key2\": \"value2\",...}"" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. * **InstanceIds** *(list) --* The IDs of the target instances. * *(string) --* **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / tag_resource tag_resource ************ OpsWorks.Client.tag_resource(**kwargs) Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks. For more information about how tagging works, see Tags in the OpsWorks User Guide. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The stack or layer's Amazon Resource Number (ARN). * **Tags** (*dict*) -- **[REQUIRED]** A map that contains tag keys and tag values that are attached to a stack or layer. * The key cannot be empty. * The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: "+ - = . _ : /" * The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: "+ - = . _ : /" * Leading and trailing white spaces are trimmed from both the key and value. * A maximum of 40 tags is allowed for any resource. * *(string) --* * *(string) --* Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_load_based_auto_scaling describe_load_based_auto_scaling ******************************** OpsWorks.Client.describe_load_based_auto_scaling(**kwargs) Describes load-based auto scaling configurations for specified layers. Note: You must specify at least one of the parameters. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_load_based_auto_scaling( LayerIds=[ 'string', ] ) Parameters: **LayerIds** (*list*) -- **[REQUIRED]** An array of layer IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'LoadBasedAutoScalingConfigurations': [ { 'LayerId': 'string', 'Enable': True|False, 'UpScaling': { 'InstanceCount': 123, 'ThresholdsWaitTime': 123, 'IgnoreMetricsTime': 123, 'CpuThreshold': 123.0, 'MemoryThreshold': 123.0, 'LoadThreshold': 123.0, 'Alarms': [ 'string', ] }, 'DownScaling': { 'InstanceCount': 123, 'ThresholdsWaitTime': 123, 'IgnoreMetricsTime': 123, 'CpuThreshold': 123.0, 'MemoryThreshold': 123.0, 'LoadThreshold': 123.0, 'Alarms': [ 'string', ] } }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeLoadBasedAutoScaling" request. * **LoadBasedAutoScalingConfigurations** *(list) --* An array of "LoadBasedAutoScalingConfiguration" objects that describe each layer's configuration. * *(dict) --* Describes a layer's load-based auto scaling configuration. * **LayerId** *(string) --* The layer ID. * **Enable** *(boolean) --* Whether load-based auto scaling is enabled for the layer. * **UpScaling** *(dict) --* An "AutoScalingThresholds" object that describes the upscaling configuration, which defines how and when OpsWorks Stacks increases the number of instances. * **InstanceCount** *(integer) --* The number of instances to add or remove when the load exceeds a threshold. * **ThresholdsWaitTime** *(integer) --* The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed. * **IgnoreMetricsTime** *(integer) --* The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. "IgnoreMetricsTime" allows you to direct OpsWorks Stacks to suppress scaling events long enough to get the new instances online. * **CpuThreshold** *(float) --* The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold. * **MemoryThreshold** *(float) --* The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold. * **LoadThreshold** *(float) --* The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing). * **Alarms** *(list) --* Custom CloudWatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack. Note: To use custom alarms, you must update your service role to allow "cloudwatch:DescribeAlarms". You can either have OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing OpsWorks Stacks to Act on Your Behalf. * *(string) --* * **DownScaling** *(dict) --* An "AutoScalingThresholds" object that describes the downscaling configuration, which defines how and when OpsWorks Stacks reduces the number of instances. * **InstanceCount** *(integer) --* The number of instances to add or remove when the load exceeds a threshold. * **ThresholdsWaitTime** *(integer) --* The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed. * **IgnoreMetricsTime** *(integer) --* The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. "IgnoreMetricsTime" allows you to direct OpsWorks Stacks to suppress scaling events long enough to get the new instances online. * **CpuThreshold** *(float) --* The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold. * **MemoryThreshold** *(float) --* The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold. * **LoadThreshold** *(float) --* The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing). * **Alarms** *(list) --* Custom CloudWatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack. Note: To use custom alarms, you must update your service role to allow "cloudwatch:DescribeAlarms". You can either have OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing OpsWorks Stacks to Act on Your Behalf. * *(string) --* **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / delete_layer delete_layer ************ OpsWorks.Client.delete_layer(**kwargs) Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.delete_layer( LayerId='string' ) Parameters: **LayerId** (*string*) -- **[REQUIRED]** The layer ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / clone_stack clone_stack *********** OpsWorks.Client.clone_stack(**kwargs) Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack. **Required Permissions**: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.clone_stack( SourceStackId='string', Name='string', Region='string', VpcId='string', Attributes={ 'string': 'string' }, ServiceRoleArn='string', DefaultInstanceProfileArn='string', DefaultOs='string', HostnameTheme='string', DefaultAvailabilityZone='string', DefaultSubnetId='string', CustomJson='string', ConfigurationManager={ 'Name': 'string', 'Version': 'string' }, ChefConfiguration={ 'ManageBerkshelf': True|False, 'BerkshelfVersion': 'string' }, UseCustomCookbooks=True|False, UseOpsworksSecurityGroups=True|False, CustomCookbooksSource={ 'Type': 'git'|'svn'|'archive'|'s3', 'Url': 'string', 'Username': 'string', 'Password': 'string', 'SshKey': 'string', 'Revision': 'string' }, DefaultSshKeyName='string', ClonePermissions=True|False, CloneAppIds=[ 'string', ], DefaultRootDeviceType='ebs'|'instance-store', AgentVersion='string' ) Parameters: * **SourceStackId** (*string*) -- **[REQUIRED]** The source stack ID. * **Name** (*string*) -- The cloned stack name. Stack names can be a maximum of 64 characters. * **Region** (*string*) -- The cloned stack Amazon Web Services Region, such as "ap-northeast-2". For more information about Amazon Web Services Regions, see Regions and Endpoints. * **VpcId** (*string*) -- The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later. * If your account supports EC2 Classic, the default value is no VPC. * If your account does not support EC2 Classic, the default value is the default VPC for the specified region. If the VPC ID corresponds to a default VPC and you have specified either the "DefaultAvailabilityZone" or the "DefaultSubnetId" parameter only, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. If you specify a nondefault VPC ID, note the following: * It must belong to a VPC in your account that is in the specified region. * You must specify a value for "DefaultSubnetId". For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2 Classic, see Supported Platforms. * **Attributes** (*dict*) -- A list of stack attributes and values as key/value pairs to be added to the cloned stack. * *(string) --* * *(string) --* * **ServiceRoleArn** (*string*) -- **[REQUIRED]** The stack Identity and Access Management (IAM) role, which allows OpsWorks Stacks to work with Amazon Web Services resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the OpsWorkss Stacks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers. Note: You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly. * **DefaultInstanceProfileArn** (*string*) -- The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. * **DefaultOs** (*string*) -- The stack's operating system, which must be set to one of the following. * A supported Linux operating system: An Amazon Linux version, such as "Amazon Linux 2", "Amazon Linux 2018.03", "Amazon Linux 2017.09", "Amazon Linux 2017.03", "Amazon Linux 2016.09", "Amazon Linux 2016.03", "Amazon Linux 2015.09", or "Amazon Linux 2015.03". * A supported Ubuntu operating system, such as "Ubuntu 18.04 LTS", "Ubuntu 16.04 LTS", "Ubuntu 14.04 LTS", or "Ubuntu 12.04 LTS". * "CentOS Linux 7" * "Red Hat Enterprise Linux 7" * "Microsoft Windows Server 2012 R2 Base", "Microsoft Windows Server 2012 R2 with SQL Server Express", "Microsoft Windows Server 2012 R2 with SQL Server Standard", or "Microsoft Windows Server 2012 R2 with SQL Server Web". * A custom AMI: "Custom". You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs. The default option is the parent stack's operating system. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems. Note: You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux. * **HostnameTheme** (*string*) -- The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, "HostnameTheme" is set to "Layer_Dependent", which creates host names by appending integers to the layer's short name. The other themes are: * "Baked_Goods" * "Clouds" * "Europe_Cities" * "Fruits" * "Greek_Deities_and_Titans" * "Legendary_creatures_from_Japan" * "Planets_and_Moons" * "Roman_Deities" * "Scottish_Islands" * "US_Cities" * "Wild_Cats" To obtain a generated host name, call "GetHostNameSuggestion", which returns a host name based on the current theme. * **DefaultAvailabilityZone** (*string*) -- The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for "DefaultSubnetId", the subnet must be in the same zone. For more information, see the "VpcId" parameter description. * **DefaultSubnetId** (*string*) -- The stack's default VPC subnet ID. This parameter is required if you specify a value for the "VpcId" parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for "DefaultAvailabilityZone", the subnet must be in that zone. For information on default values and when this parameter is required, see the "VpcId" parameter description. * **CustomJson** (*string*) -- A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format: ""{\"key1\": \"value1\", \"key2\": \"value2\",...}"" For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes * **ConfigurationManager** (*dict*) -- The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. * **Name** *(string) --* The name. This parameter must be set to "Chef". * **Version** *(string) --* The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12. * **ChefConfiguration** (*dict*) -- A "ChefConfiguration" object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack. * **ManageBerkshelf** *(boolean) --* Whether to enable Berkshelf. * **BerkshelfVersion** *(string) --* The Berkshelf version. * **UseCustomCookbooks** (*boolean*) -- Whether to use custom cookbooks. * **UseOpsworksSecurityGroups** (*boolean*) -- Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers. OpsWorks Stacks provides a standard set of security groups, one for each layer, which are associated with layers by default. With "UseOpsworksSecurityGroups" you can instead provide your own custom security groups. "UseOpsworksSecurityGroups" has the following settings: * True - OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built- in security group. * False - OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. For more information, see Create a New Stack. * **CustomCookbooksSource** (*dict*) -- Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes. * **Type** *(string) --* The repository type. * **Url** *(string) --* The source URL. The following is an example of an Amazon S3 source URL: "https://s3.amazonaws.com/opsworks-demo- bucket/opsworks_cookbook_demo.tar.gz". * **Username** *(string) --* This parameter depends on the repository type. * For Amazon S3 bundles, set "Username" to the appropriate IAM access key ID. * For HTTP bundles, Git repositories, and Subversion repositories, set "Username" to the user name. * **Password** *(string) --* When included in a request, the parameter depends on the repository type. * For Amazon S3 bundles, set "Password" to the appropriate IAM secret access key. * For HTTP bundles and Subversion repositories, set "Password" to the password. For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access- keys-best-practices.html. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **SshKey** *(string) --* In requests, the repository's SSH key. In responses, OpsWorks Stacks returns "*****FILTERED*****" instead of the actual value. * **Revision** *(string) --* The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. * **DefaultSshKeyName** (*string*) -- A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance. * **ClonePermissions** (*boolean*) -- Whether to clone the source stack's permissions. * **CloneAppIds** (*list*) -- A list of source stack app IDs to be included in the cloned stack. * *(string) --* * **DefaultRootDeviceType** (*string*) -- The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device. * **AgentVersion** (*string*) -- The default OpsWorks Stacks agent version. You have the following options: * Auto-update - Set this parameter to "LATEST". OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. * Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. OpsWorks Stacks automatically installs that version on the stack's instances. The default setting is "LATEST". To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. Note: You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. Return type: dict Returns: **Response Syntax** { 'StackId': 'string' } **Response Structure** * *(dict) --* Contains the response to a "CloneStack" request. * **StackId** *(string) --* The cloned stack ID. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_commands describe_commands ***************** OpsWorks.Client.describe_commands(**kwargs) Describes the results of specified commands. Note: This call accepts only one resource-identifying parameter. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_commands( DeploymentId='string', InstanceId='string', CommandIds=[ 'string', ] ) Parameters: * **DeploymentId** (*string*) -- The deployment ID. If you include this parameter, "DescribeCommands" returns a description of the commands associated with the specified deployment. * **InstanceId** (*string*) -- The instance ID. If you include this parameter, "DescribeCommands" returns a description of the commands associated with the specified instance. * **CommandIds** (*list*) -- An array of command IDs. If you include this parameter, "DescribeCommands" returns a description of the specified commands. Otherwise, it returns a description of every command. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Commands': [ { 'CommandId': 'string', 'InstanceId': 'string', 'DeploymentId': 'string', 'CreatedAt': 'string', 'AcknowledgedAt': 'string', 'CompletedAt': 'string', 'Status': 'string', 'ExitCode': 123, 'LogUrl': 'string', 'Type': 'string' }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeCommands" request. * **Commands** *(list) --* An array of "Command" objects that describe each of the specified commands. * *(dict) --* Describes a command. * **CommandId** *(string) --* The command ID. * **InstanceId** *(string) --* The ID of the instance where the command was executed. * **DeploymentId** *(string) --* The command deployment ID. * **CreatedAt** *(string) --* Date and time when the command was run. * **AcknowledgedAt** *(string) --* Date and time when the command was acknowledged. * **CompletedAt** *(string) --* Date when the command completed. * **Status** *(string) --* The command status: * failed * successful * skipped * pending * **ExitCode** *(integer) --* The command exit code. * **LogUrl** *(string) --* The URL of the command log. * **Type** *(string) --* The command type: * "configure" * "deploy" * "execute_recipes" * "install_dependencies" * "restart" * "rollback" * "setup" * "start" * "stop" * "undeploy" * "update_custom_cookbooks" * "update_dependencies" **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / update_user_profile update_user_profile ******************* OpsWorks.Client.update_user_profile(**kwargs) Updates a specified user profile. **Required Permissions**: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.update_user_profile( IamUserArn='string', SshUsername='string', SshPublicKey='string', AllowSelfManagement=True|False ) Parameters: * **IamUserArn** (*string*) -- **[REQUIRED]** The user IAM ARN. This can also be a federated user's ARN. * **SshUsername** (*string*) -- The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, OpsWorks Stacks removes them. For example, "my.name" will be changed to "myname". If you do not specify an SSH user name, OpsWorks Stacks generates one from the IAM user name. * **SshPublicKey** (*string*) -- The user's new SSH public key. * **AllowSelfManagement** (*boolean*) -- Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / delete_app delete_app ********** OpsWorks.Client.delete_app(**kwargs) Deletes a specified app. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.delete_app( AppId='string' ) Parameters: **AppId** (*string*) -- **[REQUIRED]** The app ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_elastic_ips describe_elastic_ips ******************** OpsWorks.Client.describe_elastic_ips(**kwargs) Describes Elastic IP addresses. Note: This call accepts only one resource-identifying parameter. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_elastic_ips( InstanceId='string', StackId='string', Ips=[ 'string', ] ) Parameters: * **InstanceId** (*string*) -- The instance ID. If you include this parameter, "DescribeElasticIps" returns a description of the Elastic IP addresses associated with the specified instance. * **StackId** (*string*) -- A stack ID. If you include this parameter, "DescribeElasticIps" returns a description of the Elastic IP addresses that are registered with the specified stack. * **Ips** (*list*) -- An array of Elastic IP addresses to be described. If you include this parameter, "DescribeElasticIps" returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ElasticIps': [ { 'Ip': 'string', 'Name': 'string', 'Domain': 'string', 'Region': 'string', 'InstanceId': 'string' }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeElasticIps" request. * **ElasticIps** *(list) --* An "ElasticIps" object that describes the specified Elastic IP addresses. * *(dict) --* Describes an Elastic IP address. * **Ip** *(string) --* The IP address. * **Name** *(string) --* The name, which can be a maximum of 32 characters. * **Domain** *(string) --* The domain. * **Region** *(string) --* The Amazon Web Services Region. For more information, see Regions and Endpoints. * **InstanceId** *(string) --* The ID of the instance that the address is attached to. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / describe_volumes describe_volumes **************** OpsWorks.Client.describe_volumes(**kwargs) Describes an instance's Amazon EBS volumes. Note: This call accepts only one resource-identifying parameter. **Required Permissions**: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_volumes( InstanceId='string', StackId='string', RaidArrayId='string', VolumeIds=[ 'string', ] ) Parameters: * **InstanceId** (*string*) -- The instance ID. If you use this parameter, "DescribeVolumes" returns descriptions of the volumes associated with the specified instance. * **StackId** (*string*) -- A stack ID. The action describes the stack's registered Amazon EBS volumes. * **RaidArrayId** (*string*) -- The RAID array ID. If you use this parameter, "DescribeVolumes" returns descriptions of the volumes associated with the specified RAID array. * **VolumeIds** (*list*) -- Am array of volume IDs. If you use this parameter, "DescribeVolumes" returns descriptions of the specified volumes. Otherwise, it returns a description of every volume. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Volumes': [ { 'VolumeId': 'string', 'Ec2VolumeId': 'string', 'Name': 'string', 'RaidArrayId': 'string', 'InstanceId': 'string', 'Status': 'string', 'Size': 123, 'Device': 'string', 'MountPoint': 'string', 'Region': 'string', 'AvailabilityZone': 'string', 'VolumeType': 'string', 'Iops': 123, 'Encrypted': True|False }, ] } **Response Structure** * *(dict) --* Contains the response to a "DescribeVolumes" request. * **Volumes** *(list) --* An array of volume IDs. * *(dict) --* Describes an instance's Amazon EBS volume. * **VolumeId** *(string) --* The volume ID. * **Ec2VolumeId** *(string) --* The Amazon EC2 volume ID. * **Name** *(string) --* The volume name. Volume names are a maximum of 128 characters. * **RaidArrayId** *(string) --* The RAID array ID. * **InstanceId** *(string) --* The instance ID. * **Status** *(string) --* The value returned by DescribeVolumes. * **Size** *(integer) --* The volume size. * **Device** *(string) --* The device name. * **MountPoint** *(string) --* The volume mount point. For example, "/mnt/disk1". * **Region** *(string) --* The Amazon Web Services Region. For more information about Amazon Web Services Regions, see Regions and Endpoints. * **AvailabilityZone** *(string) --* The volume Availability Zone. For more information, see Regions and Endpoints. * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS Volume Types. * "standard" - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB. * "io1" - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB. * "gp2" - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB. * "st1" - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * "sc1" - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. * **Iops** *(integer) --* For PIOPS volumes, the IOPS per disk. * **Encrypted** *(boolean) --* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / grant_access grant_access ************ OpsWorks.Client.grant_access(**kwargs) Note: This action can be used only with Windows stacks. Grants RDP access to a Windows instance for a specified time period. See also: AWS API Documentation **Request Syntax** response = client.grant_access( InstanceId='string', ValidForInMinutes=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The instance's OpsWorks Stacks ID. * **ValidForInMinutes** (*integer*) -- The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, they are logged out. Return type: dict Returns: **Response Syntax** { 'TemporaryCredential': { 'Username': 'string', 'Password': 'string', 'ValidForInMinutes': 123, 'InstanceId': 'string' } } **Response Structure** * *(dict) --* Contains the response to a "GrantAccess" request. * **TemporaryCredential** *(dict) --* A "TemporaryCredential" object that contains the data needed to log in to the instance by RDP clients, such as the Microsoft Remote Desktop Connection. * **Username** *(string) --* The user name. * **Password** *(string) --* The password. * **ValidForInMinutes** *(integer) --* The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, the user will no longer be able to use the credentials to log in. If they are logged in at the time, they are automatically logged out. * **InstanceId** *(string) --* The instance's OpsWorks Stacks ID. **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException" OpsWorks / Client / deregister_instance deregister_instance ******************* OpsWorks.Client.deregister_instance(**kwargs) Deregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. This action removes the instance from the stack and returns it to your control. **Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. See also: AWS API Documentation **Request Syntax** response = client.deregister_instance( InstanceId='string' ) Parameters: **InstanceId** (*string*) -- **[REQUIRED]** The instance ID. Returns: None **Exceptions** * "OpsWorks.Client.exceptions.ValidationException" * "OpsWorks.Client.exceptions.ResourceNotFoundException"