Skip to content

LaunchWizardClient#

Index > LaunchWizard > LaunchWizardClient

Auto-generated documentation for LaunchWizard type annotations stubs module mypy-boto3-launch-wizard.

LaunchWizardClient#

Type annotations and code completion for boto3.client("launch-wizard"). boto3 documentation

# LaunchWizardClient usage example

from boto3.session import Session
from mypy_boto3_launch_wizard.client import LaunchWizardClient

def get_launch-wizard_client() -> LaunchWizardClient:
    return Session().client("launch-wizard")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("launch-wizard").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("launch-wizard")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceLimitException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_launch_wizard.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("launch-wizard").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("launch-wizard").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_deployment#

Creates a deployment for the given workload.

Type annotations and code completion for boto3.client("launch-wizard").create_deployment method. boto3 documentation

# create_deployment method definition

def create_deployment(
    self,
    *,
    deploymentPatternName: str,
    name: str,
    specifications: Mapping[str, str],
    workloadName: str,
    dryRun: bool = ...,
    tags: Mapping[str, str] = ...,
) -> CreateDeploymentOutputTypeDef:  # (1)
    ...
  1. See CreateDeploymentOutputTypeDef 
# create_deployment method usage example with argument unpacking

kwargs: CreateDeploymentInputRequestTypeDef = {  # (1)
    "deploymentPatternName": ...,
    "name": ...,
    "specifications": ...,
    "workloadName": ...,
}

parent.create_deployment(**kwargs)
  1. See CreateDeploymentInputRequestTypeDef

delete_deployment#

Deletes a deployment.

Type annotations and code completion for boto3.client("launch-wizard").delete_deployment method. boto3 documentation

# delete_deployment method definition

def delete_deployment(
    self,
    *,
    deploymentId: str,
) -> DeleteDeploymentOutputTypeDef:  # (1)
    ...
  1. See DeleteDeploymentOutputTypeDef 
# delete_deployment method usage example with argument unpacking

kwargs: DeleteDeploymentInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

parent.delete_deployment(**kwargs)
  1. See DeleteDeploymentInputRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("launch-wizard").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_deployment#

Returns information about the deployment.

Type annotations and code completion for boto3.client("launch-wizard").get_deployment method. boto3 documentation

# get_deployment method definition

def get_deployment(
    self,
    *,
    deploymentId: str,
) -> GetDeploymentOutputTypeDef:  # (1)
    ...
  1. See GetDeploymentOutputTypeDef 
# get_deployment method usage example with argument unpacking

kwargs: GetDeploymentInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

parent.get_deployment(**kwargs)
  1. See GetDeploymentInputRequestTypeDef

get_workload#

Returns information about a workload.

Type annotations and code completion for boto3.client("launch-wizard").get_workload method. boto3 documentation

# get_workload method definition

def get_workload(
    self,
    *,
    workloadName: str,
) -> GetWorkloadOutputTypeDef:  # (1)
    ...
  1. See GetWorkloadOutputTypeDef 
# get_workload method usage example with argument unpacking

kwargs: GetWorkloadInputRequestTypeDef = {  # (1)
    "workloadName": ...,
}

parent.get_workload(**kwargs)
  1. See GetWorkloadInputRequestTypeDef

get_workload_deployment_pattern#

Returns details for a given workload and deployment pattern, including the available specifications.

Type annotations and code completion for boto3.client("launch-wizard").get_workload_deployment_pattern method. boto3 documentation

# get_workload_deployment_pattern method definition

def get_workload_deployment_pattern(
    self,
    *,
    deploymentPatternName: str,
    workloadName: str,
) -> GetWorkloadDeploymentPatternOutputTypeDef:  # (1)
    ...
  1. See GetWorkloadDeploymentPatternOutputTypeDef 
# get_workload_deployment_pattern method usage example with argument unpacking

kwargs: GetWorkloadDeploymentPatternInputRequestTypeDef = {  # (1)
    "deploymentPatternName": ...,
    "workloadName": ...,
}

parent.get_workload_deployment_pattern(**kwargs)
  1. See GetWorkloadDeploymentPatternInputRequestTypeDef

list_deployment_events#

Lists the events of a deployment.

Type annotations and code completion for boto3.client("launch-wizard").list_deployment_events method. boto3 documentation

# list_deployment_events method definition

def list_deployment_events(
    self,
    *,
    deploymentId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDeploymentEventsOutputTypeDef:  # (1)
    ...
  1. See ListDeploymentEventsOutputTypeDef 
# list_deployment_events method usage example with argument unpacking

kwargs: ListDeploymentEventsInputRequestTypeDef = {  # (1)
    "deploymentId": ...,
}

parent.list_deployment_events(**kwargs)
  1. See ListDeploymentEventsInputRequestTypeDef

list_deployments#

Lists the deployments that have been created.

Type annotations and code completion for boto3.client("launch-wizard").list_deployments method. boto3 documentation

# list_deployments method definition

def list_deployments(
    self,
    *,
    filters: Sequence[DeploymentFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDeploymentsOutputTypeDef:  # (2)
    ...
  1. See DeploymentFilterTypeDef
  2. See ListDeploymentsOutputTypeDef 
# list_deployments method usage example with argument unpacking

kwargs: ListDeploymentsInputRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_deployments(**kwargs)
  1. See ListDeploymentsInputRequestTypeDef

list_tags_for_resource#

Lists the tags associated with a specified resource.

Type annotations and code completion for boto3.client("launch-wizard").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

list_workload_deployment_patterns#

Lists the workload deployment patterns for a given workload name.

Type annotations and code completion for boto3.client("launch-wizard").list_workload_deployment_patterns method. boto3 documentation

# list_workload_deployment_patterns method definition

def list_workload_deployment_patterns(
    self,
    *,
    workloadName: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkloadDeploymentPatternsOutputTypeDef:  # (1)
    ...
  1. See ListWorkloadDeploymentPatternsOutputTypeDef 
# list_workload_deployment_patterns method usage example with argument unpacking

kwargs: ListWorkloadDeploymentPatternsInputRequestTypeDef = {  # (1)
    "workloadName": ...,
}

parent.list_workload_deployment_patterns(**kwargs)
  1. See ListWorkloadDeploymentPatternsInputRequestTypeDef

list_workloads#

Lists the available workload names.

Type annotations and code completion for boto3.client("launch-wizard").list_workloads method. boto3 documentation

# list_workloads method definition

def list_workloads(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkloadsOutputTypeDef:  # (1)
    ...
  1. See ListWorkloadsOutputTypeDef 
# list_workloads method usage example with argument unpacking

kwargs: ListWorkloadsInputRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_workloads(**kwargs)
  1. See ListWorkloadsInputRequestTypeDef

tag_resource#

Adds the specified tags to the given resource.

Type annotations and code completion for boto3.client("launch-wizard").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputRequestTypeDef

untag_resource#

Removes the specified tags from the given resource.

Type annotations and code completion for boto3.client("launch-wizard").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("launch-wizard").get_paginator method with overloads.