LaunchWizard ************ Client ====== class LaunchWizard.Client A low-level client representing AWS Launch Wizard Launch Wizard offers a guided way of sizing, configuring, and deploying Amazon Web Services resources for third party applications, such as Microsoft SQL Server Always On and HANA based SAP systems, without the need to manually identify and provision individual Amazon Web Services resources. import boto3 client = boto3.client('launch-wizard') These are the available methods: * can_paginate * close * create_deployment * delete_deployment * get_deployment * get_paginator * get_waiter * get_workload * get_workload_deployment_pattern * list_deployment_events * list_deployments * list_tags_for_resource * list_workload_deployment_patterns * list_workloads * tag_resource * untag_resource 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: * ListDeploymentEvents * ListDeployments * ListWorkloadDeploymentPatterns * ListWorkloads LaunchWizard / Paginator / ListDeploymentEvents ListDeploymentEvents ******************** class LaunchWizard.Paginator.ListDeploymentEvents paginator = client.get_paginator('list_deployment_events') paginate(**kwargs) Creates an iterator that will paginate through responses from "LaunchWizard.Client.list_deployment_events()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( deploymentId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **deploymentId** (*string*) -- **[REQUIRED]** The ID of the deployment. * **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** { 'deploymentEvents': [ { 'description': 'string', 'name': 'string', 'status': 'CANCELED'|'CANCELING'|'COMPLETED'|'CREATED'|'FAILED'|'IN_PROGRESS'|'PENDING'|'TIMED_OUT', 'statusReason': 'string', 'timestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **deploymentEvents** *(list) --* Lists the deployment events. * *(dict) --* A summary of the deployment event data. * **description** *(string) --* The description of the deployment event. * **name** *(string) --* The name of the deployment event. * **status** *(string) --* The status of the deployment event. * **statusReason** *(string) --* The reason of the deployment event status. * **timestamp** *(datetime) --* The timestamp of the deployment event. * **NextToken** *(string) --* A token to resume pagination. LaunchWizard / Paginator / ListWorkloadDeploymentPatterns ListWorkloadDeploymentPatterns ****************************** class LaunchWizard.Paginator.ListWorkloadDeploymentPatterns paginator = client.get_paginator('list_workload_deployment_patterns') paginate(**kwargs) Creates an iterator that will paginate through responses from "LaunchWizard.Client.list_workload_deployment_patterns()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( workloadName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **workloadName** (*string*) -- **[REQUIRED]** The name of the workload. * **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** { 'workloadDeploymentPatterns': [ { 'deploymentPatternName': 'string', 'description': 'string', 'displayName': 'string', 'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED', 'statusMessage': 'string', 'workloadName': 'string', 'workloadVersionName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **workloadDeploymentPatterns** *(list) --* Describes the workload deployment patterns. * *(dict) --* Describes a workload deployment pattern. * **deploymentPatternName** *(string) --* The name of a workload deployment pattern. * **description** *(string) --* The description of a workload deployment pattern. * **displayName** *(string) --* The display name of a workload deployment pattern. * **status** *(string) --* The status of a workload deployment pattern. * **statusMessage** *(string) --* A message about a workload deployment pattern's status. * **workloadName** *(string) --* The name of the workload. * **workloadVersionName** *(string) --* The name of the workload deployment pattern version. * **NextToken** *(string) --* A token to resume pagination. LaunchWizard / Paginator / ListWorkloads ListWorkloads ************* class LaunchWizard.Paginator.ListWorkloads paginator = client.get_paginator('list_workloads') paginate(**kwargs) Creates an iterator that will paginate through responses from "LaunchWizard.Client.list_workloads()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **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** { 'workloads': [ { 'displayName': 'string', 'workloadName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **workloads** *(list) --* Information about the workloads. * *(dict) --* Describes workload data. * **displayName** *(string) --* The display name of the workload data. * **workloadName** *(string) --* The name of the workload. * **NextToken** *(string) --* A token to resume pagination. LaunchWizard / Paginator / ListDeployments ListDeployments *************** class LaunchWizard.Paginator.ListDeployments paginator = client.get_paginator('list_deployments') paginate(**kwargs) Creates an iterator that will paginate through responses from "LaunchWizard.Client.list_deployments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters=[ { 'name': 'WORKLOAD_NAME'|'DEPLOYMENT_STATUS', 'values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filters** (*list*) -- Filters to scope the results. The following filters are supported: * "WORKLOAD_NAME" - The name used in deployments. * "DEPLOYMENT_STATUS" - "COMPLETED" | "CREATING" | "DELETE_IN_PROGRESS" | "DELETE_INITIATING" | "DELETE_FAILED" | "DELETED" | "FAILED" | "IN_PROGRESS" | "VALIDATING" * *(dict) --* A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria. * **name** *(string) --* The name of the filter. Filter names are case- sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **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** { 'deployments': [ { 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'name': 'string', 'patternName': 'string', 'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING', 'workloadName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **deployments** *(list) --* Lists the deployments. * *(dict) --* A summary of the deployment data. * **createdAt** *(datetime) --* The time the deployment was created. * **id** *(string) --* The ID of the deployment. * **name** *(string) --* The name of the deployment * **patternName** *(string) --* The name of the workload deployment pattern. * **status** *(string) --* The status of the deployment. * **workloadName** *(string) --* The name of the workload. * **NextToken** *(string) --* A token to resume pagination. LaunchWizard / Client / get_paginator get_paginator ************* LaunchWizard.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. LaunchWizard / Client / can_paginate can_paginate ************ LaunchWizard.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. LaunchWizard / Client / delete_deployment delete_deployment ***************** LaunchWizard.Client.delete_deployment(**kwargs) Deletes a deployment. See also: AWS API Documentation **Request Syntax** response = client.delete_deployment( deploymentId='string' ) Parameters: **deploymentId** (*string*) -- **[REQUIRED]** The ID of the deployment. Return type: dict Returns: **Response Syntax** { 'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING', 'statusReason': 'string' } **Response Structure** * *(dict) --* * **status** *(string) --* The status of the deployment. * **statusReason** *(string) --* The reason for the deployment status. **Exceptions** * "LaunchWizard.Client.exceptions.ResourceLimitException" * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" * "LaunchWizard.Client.exceptions.ResourceNotFoundException" LaunchWizard / Client / list_deployment_events list_deployment_events ********************** LaunchWizard.Client.list_deployment_events(**kwargs) Lists the events of a deployment. See also: AWS API Documentation **Request Syntax** response = client.list_deployment_events( deploymentId='string', maxResults=123, nextToken='string' ) Parameters: * **deploymentId** (*string*) -- **[REQUIRED]** The ID of the deployment. * **maxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. * **nextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Return type: dict Returns: **Response Syntax** { 'deploymentEvents': [ { 'description': 'string', 'name': 'string', 'status': 'CANCELED'|'CANCELING'|'COMPLETED'|'CREATED'|'FAILED'|'IN_PROGRESS'|'PENDING'|'TIMED_OUT', 'statusReason': 'string', 'timestamp': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **deploymentEvents** *(list) --* Lists the deployment events. * *(dict) --* A summary of the deployment event data. * **description** *(string) --* The description of the deployment event. * **name** *(string) --* The name of the deployment event. * **status** *(string) --* The status of the deployment event. * **statusReason** *(string) --* The reason of the deployment event status. * **timestamp** *(datetime) --* The timestamp of the deployment event. * **nextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. **Exceptions** * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" * "LaunchWizard.Client.exceptions.ResourceNotFoundException" LaunchWizard / Client / list_tags_for_resource list_tags_for_resource ********************** LaunchWizard.Client.list_tags_for_resource(**kwargs) Lists the tags associated with a specified resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* Information about the tags. * *(string) --* * *(string) --* **Exceptions** * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" * "LaunchWizard.Client.exceptions.ResourceNotFoundException" LaunchWizard / Client / untag_resource untag_resource ************** LaunchWizard.Client.untag_resource(**kwargs) Removes the specified tags from the given resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. * **tagKeys** (*list*) -- **[REQUIRED]** Keys identifying the tags to remove. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" * "LaunchWizard.Client.exceptions.ResourceNotFoundException" LaunchWizard / Client / list_workload_deployment_patterns list_workload_deployment_patterns ********************************* LaunchWizard.Client.list_workload_deployment_patterns(**kwargs) Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names. See also: AWS API Documentation **Request Syntax** response = client.list_workload_deployment_patterns( maxResults=123, nextToken='string', workloadName='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. * **nextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **workloadName** (*string*) -- **[REQUIRED]** The name of the workload. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'workloadDeploymentPatterns': [ { 'deploymentPatternName': 'string', 'description': 'string', 'displayName': 'string', 'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED', 'statusMessage': 'string', 'workloadName': 'string', 'workloadVersionName': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **workloadDeploymentPatterns** *(list) --* Describes the workload deployment patterns. * *(dict) --* Describes a workload deployment pattern. * **deploymentPatternName** *(string) --* The name of a workload deployment pattern. * **description** *(string) --* The description of a workload deployment pattern. * **displayName** *(string) --* The display name of a workload deployment pattern. * **status** *(string) --* The status of a workload deployment pattern. * **statusMessage** *(string) --* A message about a workload deployment pattern's status. * **workloadName** *(string) --* The name of the workload. * **workloadVersionName** *(string) --* The name of the workload deployment pattern version. **Exceptions** * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" * "LaunchWizard.Client.exceptions.ResourceNotFoundException" LaunchWizard / Client / get_waiter get_waiter ********** LaunchWizard.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" LaunchWizard / Client / list_deployments list_deployments **************** LaunchWizard.Client.list_deployments(**kwargs) Lists the deployments that have been created. See also: AWS API Documentation **Request Syntax** response = client.list_deployments( filters=[ { 'name': 'WORKLOAD_NAME'|'DEPLOYMENT_STATUS', 'values': [ 'string', ] }, ], maxResults=123, nextToken='string' ) Parameters: * **filters** (*list*) -- Filters to scope the results. The following filters are supported: * "WORKLOAD_NAME" - The name used in deployments. * "DEPLOYMENT_STATUS" - "COMPLETED" | "CREATING" | "DELETE_IN_PROGRESS" | "DELETE_INITIATING" | "DELETE_FAILED" | "DELETED" | "FAILED" | "IN_PROGRESS" | "VALIDATING" * *(dict) --* A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria. * **name** *(string) --* The name of the filter. Filter names are case-sensitive. * **values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **maxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. * **nextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Return type: dict Returns: **Response Syntax** { 'deployments': [ { 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'name': 'string', 'patternName': 'string', 'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING', 'workloadName': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **deployments** *(list) --* Lists the deployments. * *(dict) --* A summary of the deployment data. * **createdAt** *(datetime) --* The time the deployment was created. * **id** *(string) --* The ID of the deployment. * **name** *(string) --* The name of the deployment * **patternName** *(string) --* The name of the workload deployment pattern. * **status** *(string) --* The status of the deployment. * **workloadName** *(string) --* The name of the workload. * **nextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. **Exceptions** * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" LaunchWizard / Client / get_deployment get_deployment ************** LaunchWizard.Client.get_deployment(**kwargs) Returns information about the deployment. See also: AWS API Documentation **Request Syntax** response = client.get_deployment( deploymentId='string' ) Parameters: **deploymentId** (*string*) -- **[REQUIRED]** The ID of the deployment. Return type: dict Returns: **Response Syntax** { 'deployment': { 'createdAt': datetime(2015, 1, 1), 'deletedAt': datetime(2015, 1, 1), 'deploymentArn': 'string', 'id': 'string', 'name': 'string', 'patternName': 'string', 'resourceGroup': 'string', 'specifications': { 'string': 'string' }, 'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING', 'tags': { 'string': 'string' }, 'workloadName': 'string' } } **Response Structure** * *(dict) --* * **deployment** *(dict) --* An object that details the deployment. * **createdAt** *(datetime) --* The time the deployment was created. * **deletedAt** *(datetime) --* The time the deployment was deleted. * **deploymentArn** *(string) --* The Amazon Resource Name (ARN) of the deployment. * **id** *(string) --* The ID of the deployment. * **name** *(string) --* The name of the deployment. * **patternName** *(string) --* The pattern name of the deployment. * **resourceGroup** *(string) --* The resource group of the deployment. * **specifications** *(dict) --* The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation. * *(string) --* * *(string) --* * **status** *(string) --* The status of the deployment. * **tags** *(dict) --* Information about the tags attached to a deployment. * *(string) --* * *(string) --* * **workloadName** *(string) --* The name of the workload. **Exceptions** * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" * "LaunchWizard.Client.exceptions.ResourceNotFoundException" LaunchWizard / Client / list_workloads list_workloads ************** LaunchWizard.Client.list_workloads(**kwargs) Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload. See also: AWS API Documentation **Request Syntax** response = client.list_workloads( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. * **nextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'workloads': [ { 'displayName': 'string', 'workloadName': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **workloads** *(list) --* Information about the workloads. * *(dict) --* Describes workload data. * **displayName** *(string) --* The display name of the workload data. * **workloadName** *(string) --* The name of the workload. **Exceptions** * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" LaunchWizard / Client / close close ***** LaunchWizard.Client.close() Closes underlying endpoint connections. LaunchWizard / Client / get_workload_deployment_pattern get_workload_deployment_pattern ******************************* LaunchWizard.Client.get_workload_deployment_pattern(**kwargs) Returns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload. See also: AWS API Documentation **Request Syntax** response = client.get_workload_deployment_pattern( deploymentPatternName='string', workloadName='string' ) Parameters: * **deploymentPatternName** (*string*) -- **[REQUIRED]** The name of the deployment pattern. * **workloadName** (*string*) -- **[REQUIRED]** The name of the workload. Return type: dict Returns: **Response Syntax** { 'workloadDeploymentPattern': { 'deploymentPatternName': 'string', 'description': 'string', 'displayName': 'string', 'specifications': [ { 'allowedValues': [ 'string', ], 'conditionals': [ { 'comparator': 'string', 'name': 'string', 'value': 'string' }, ], 'description': 'string', 'name': 'string', 'required': 'string' }, ], 'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED', 'statusMessage': 'string', 'workloadName': 'string', 'workloadVersionName': 'string' } } **Response Structure** * *(dict) --* * **workloadDeploymentPattern** *(dict) --* Details about the workload deployment pattern. * **deploymentPatternName** *(string) --* The name of the deployment pattern. * **description** *(string) --* The description of the deployment pattern. * **displayName** *(string) --* The display name of the deployment pattern. * **specifications** *(list) --* The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation. * *(dict) --* A field that details a specification of a deployment pattern. * **allowedValues** *(list) --* The allowed values of the deployment specification. * *(string) --* * **conditionals** *(list) --* The conditionals used for the deployment specification. * *(dict) --* A field that details a condition of the specifications for a deployment. * **comparator** *(string) --* The comparator of the condition. Valid values: "Equal | NotEqual" * **name** *(string) --* The name of the deployment condition. * **value** *(string) --* The value of the condition. * **description** *(string) --* The description of the deployment specification. * **name** *(string) --* The name of the deployment specification. * **required** *(string) --* Indicates if the deployment specification is required. * **status** *(string) --* The status of the deployment pattern. * **statusMessage** *(string) --* The status message of the deployment pattern. * **workloadName** *(string) --* The workload name of the deployment pattern. * **workloadVersionName** *(string) --* The workload version name of the deployment pattern. **Exceptions** * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" * "LaunchWizard.Client.exceptions.ResourceNotFoundException" LaunchWizard / Client / get_workload get_workload ************ LaunchWizard.Client.get_workload(**kwargs) Returns information about a workload. See also: AWS API Documentation **Request Syntax** response = client.get_workload( workloadName='string' ) Parameters: **workloadName** (*string*) -- **[REQUIRED]** The name of the workload. Return type: dict Returns: **Response Syntax** { 'workload': { 'description': 'string', 'displayName': 'string', 'documentationUrl': 'string', 'iconUrl': 'string', 'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED', 'statusMessage': 'string', 'workloadName': 'string' } } **Response Structure** * *(dict) --* * **workload** *(dict) --* Information about the workload. * **description** *(string) --* The description of a workload. * **displayName** *(string) --* The display name of a workload. * **documentationUrl** *(string) --* The URL of a workload document. * **iconUrl** *(string) --* The URL of a workload icon. * **status** *(string) --* The status of a workload. * **statusMessage** *(string) --* The message about a workload's status. * **workloadName** *(string) --* The name of the workload. **Exceptions** * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" * "LaunchWizard.Client.exceptions.ResourceNotFoundException" LaunchWizard / Client / create_deployment create_deployment ***************** LaunchWizard.Client.create_deployment(**kwargs) Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the "Clone deployment" action on. See also: AWS API Documentation **Request Syntax** response = client.create_deployment( deploymentPatternName='string', dryRun=True|False, name='string', specifications={ 'string': 'string' }, tags={ 'string': 'string' }, workloadName='string' ) Parameters: * **deploymentPatternName** (*string*) -- **[REQUIRED]** The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter. * **dryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **name** (*string*) -- **[REQUIRED]** The name of the deployment. * **specifications** (*dict*) -- **[REQUIRED]** The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation. * *(string) --* * *(string) --* * **tags** (*dict*) -- The tags to add to the deployment. * *(string) --* * *(string) --* * **workloadName** (*string*) -- **[REQUIRED]** The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter. Return type: dict Returns: **Response Syntax** { 'deploymentId': 'string' } **Response Structure** * *(dict) --* * **deploymentId** *(string) --* The ID of the deployment. **Exceptions** * "LaunchWizard.Client.exceptions.ResourceLimitException" * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" * "LaunchWizard.Client.exceptions.ResourceNotFoundException" LaunchWizard / Client / tag_resource tag_resource ************ LaunchWizard.Client.tag_resource(**kwargs) Adds the specified tags to the given resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. * **tags** (*dict*) -- **[REQUIRED]** One or more tags to attach to the resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LaunchWizard.Client.exceptions.InternalServerException" * "LaunchWizard.Client.exceptions.ValidationException" * "LaunchWizard.Client.exceptions.ResourceNotFoundException"