SystemsManagerQuickSetupClient

Index > SystemsManagerQuickSetup > SystemsManagerQuickSetupClient

Auto-generated documentation for SystemsManagerQuickSetup type annotations stubs module mypy-boto3-ssm-quicksetup.

SystemsManagerQuickSetupClient

Type annotations and code completion for boto3.client("ssm-quicksetup"). boto3 documentation

# SystemsManagerQuickSetupClient usage example

from boto3.session import Session
from mypy_boto3_ssm_quicksetup.client import SystemsManagerQuickSetupClient

def get_ssm-quicksetup_client() -> SystemsManagerQuickSetupClient:
    return Session().client("ssm-quicksetup")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("ssm-quicksetup")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_ssm_quicksetup.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

Type annotations and code completion for boto3.client("ssm-quicksetup").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:
    ...

create_configuration_manager

Creates a Quick Setup configuration manager resource.

Type annotations and code completion for boto3.client("ssm-quicksetup").create_configuration_manager method. boto3 documentation

# create_configuration_manager method definition

def create_configuration_manager(
    self,
    *,
    ConfigurationDefinitions: Sequence[ConfigurationDefinitionInputTypeDef],  # (1)
    Description: str = ...,
    Name: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateConfigurationManagerOutputTypeDef:  # (2)
    ...

1. See ConfigurationDefinitionInputTypeDef
2. See CreateConfigurationManagerOutputTypeDef

# create_configuration_manager method usage example with argument unpacking

kwargs: CreateConfigurationManagerInputRequestTypeDef = {  # (1)
    "ConfigurationDefinitions": ...,
}

parent.create_configuration_manager(**kwargs)

1. See CreateConfigurationManagerInputRequestTypeDef

delete_configuration_manager

Deletes a configuration manager.

Type annotations and code completion for boto3.client("ssm-quicksetup").delete_configuration_manager method. boto3 documentation

# delete_configuration_manager method definition

def delete_configuration_manager(
    self,
    *,
    ManagerArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_configuration_manager method usage example with argument unpacking

kwargs: DeleteConfigurationManagerInputRequestTypeDef = {  # (1)
    "ManagerArn": ...,
}

parent.delete_configuration_manager(**kwargs)

1. See DeleteConfigurationManagerInputRequestTypeDef

get_configuration

Returns details about the specified configuration.

Type annotations and code completion for boto3.client("ssm-quicksetup").get_configuration method. boto3 documentation

# get_configuration method definition

def get_configuration(
    self,
    *,
    ConfigurationId: str,
) -> GetConfigurationOutputTypeDef:  # (1)
    ...

1. See GetConfigurationOutputTypeDef

# get_configuration method usage example with argument unpacking

kwargs: GetConfigurationInputRequestTypeDef = {  # (1)
    "ConfigurationId": ...,
}

parent.get_configuration(**kwargs)

1. See GetConfigurationInputRequestTypeDef

get_configuration_manager

Returns a configuration manager.

Type annotations and code completion for boto3.client("ssm-quicksetup").get_configuration_manager method. boto3 documentation

# get_configuration_manager method definition

def get_configuration_manager(
    self,
    *,
    ManagerArn: str,
) -> GetConfigurationManagerOutputTypeDef:  # (1)
    ...

1. See GetConfigurationManagerOutputTypeDef

# get_configuration_manager method usage example with argument unpacking

kwargs: GetConfigurationManagerInputRequestTypeDef = {  # (1)
    "ManagerArn": ...,
}

parent.get_configuration_manager(**kwargs)

1. See GetConfigurationManagerInputRequestTypeDef

get_service_settings

Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

Type annotations and code completion for boto3.client("ssm-quicksetup").get_service_settings method. boto3 documentation

# get_service_settings method definition

def get_service_settings(
    self,
) -> GetServiceSettingsOutputTypeDef:  # (1)
    ...

1. See GetServiceSettingsOutputTypeDef

list_configuration_managers

Returns Quick Setup configuration managers.

Type annotations and code completion for boto3.client("ssm-quicksetup").list_configuration_managers method. boto3 documentation

# list_configuration_managers method definition

def list_configuration_managers(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxItems: int = ...,
    StartingToken: str = ...,
) -> ListConfigurationManagersOutputTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListConfigurationManagersOutputTypeDef

# list_configuration_managers method usage example with argument unpacking

kwargs: ListConfigurationManagersInputRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_configuration_managers(**kwargs)

1. See ListConfigurationManagersInputRequestTypeDef

list_configurations

Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

Type annotations and code completion for boto3.client("ssm-quicksetup").list_configurations method. boto3 documentation

# list_configurations method definition

def list_configurations(
    self,
    *,
    ConfigurationDefinitionId: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    ManagerArn: str = ...,
    MaxItems: int = ...,
    StartingToken: str = ...,
) -> ListConfigurationsOutputTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListConfigurationsOutputTypeDef

# list_configurations method usage example with argument unpacking

kwargs: ListConfigurationsInputRequestTypeDef = {  # (1)
    "ConfigurationDefinitionId": ...,
}

parent.list_configurations(**kwargs)

1. See ListConfigurationsInputRequestTypeDef

list_quick_setup_types

Returns the available Quick Setup types.

Type annotations and code completion for boto3.client("ssm-quicksetup").list_quick_setup_types method. boto3 documentation

# list_quick_setup_types method definition

def list_quick_setup_types(
    self,
) -> ListQuickSetupTypesOutputTypeDef:  # (1)
    ...

1. See ListQuickSetupTypesOutputTypeDef

list_tags_for_resource

Returns tags assigned to the resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

tag_resource

Assigns key-value pairs of metadata to Amazon Web Services resources.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputRequestTypeDef

untag_resource

Removes tags from the specified resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputRequestTypeDef

update_configuration_definition

Updates a Quick Setup configuration definition.

Type annotations and code completion for boto3.client("ssm-quicksetup").update_configuration_definition method. boto3 documentation

# update_configuration_definition method definition

def update_configuration_definition(
    self,
    *,
    Id: str,
    ManagerArn: str,
    LocalDeploymentAdministrationRoleArn: str = ...,
    LocalDeploymentExecutionRoleName: str = ...,
    Parameters: Mapping[str, str] = ...,
    TypeVersion: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_configuration_definition method usage example with argument unpacking

kwargs: UpdateConfigurationDefinitionInputRequestTypeDef = {  # (1)
    "Id": ...,
    "ManagerArn": ...,
}

parent.update_configuration_definition(**kwargs)

1. See UpdateConfigurationDefinitionInputRequestTypeDef

update_configuration_manager

Updates a Quick Setup configuration manager.

Type annotations and code completion for boto3.client("ssm-quicksetup").update_configuration_manager method. boto3 documentation

# update_configuration_manager method definition

def update_configuration_manager(
    self,
    *,
    ManagerArn: str,
    Description: str = ...,
    Name: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_configuration_manager method usage example with argument unpacking

kwargs: UpdateConfigurationManagerInputRequestTypeDef = {  # (1)
    "ManagerArn": ...,
}

parent.update_configuration_manager(**kwargs)

1. See UpdateConfigurationManagerInputRequestTypeDef

update_service_settings

Updates settings configured for Quick Setup.

Type annotations and code completion for boto3.client("ssm-quicksetup").update_service_settings method. boto3 documentation

# update_service_settings method definition

def update_service_settings(
    self,
    *,
    ExplorerEnablingRoleArn: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_service_settings method usage example with argument unpacking

kwargs: UpdateServiceSettingsInputRequestTypeDef = {  # (1)
    "ExplorerEnablingRoleArn": ...,
}

parent.update_service_settings(**kwargs)

1. See UpdateServiceSettingsInputRequestTypeDef

get_paginator

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

• client.get_paginator("list_configuration_managers") -> ListConfigurationManagersPaginator
• client.get_paginator("list_configurations") -> ListConfigurationsPaginator