SnowDeviceManagementClient

Index > SnowDeviceManagement > SnowDeviceManagementClient

Auto-generated documentation for SnowDeviceManagement type annotations stubs module mypy-boto3-snow-device-management.

SnowDeviceManagementClient

Type annotations and code completion for boto3.client("snow-device-management"). boto3 documentation

# SnowDeviceManagementClient usage example

from boto3.session import Session
from mypy_boto3_snow_device_management.client import SnowDeviceManagementClient

def get_snow-device-management_client() -> SnowDeviceManagementClient:
    return Session().client("snow-device-management")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("snow-device-management").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("snow-device-management")

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

# Exceptions.exceptions type checking example

from mypy_boto3_snow_device_management.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("snow-device-management").can_paginate method. boto3 documentation

# can_paginate method definition

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

cancel_task

Sends a cancel request for a specified task.

Type annotations and code completion for boto3.client("snow-device-management").cancel_task method. boto3 documentation

# cancel_task method definition

def cancel_task(
    self,
    *,
    taskId: str,
) -> CancelTaskOutputTypeDef:  # (1)
    ...

1. See CancelTaskOutputTypeDef

# cancel_task method usage example with argument unpacking

kwargs: CancelTaskInputRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.cancel_task(**kwargs)

1. See CancelTaskInputRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("snow-device-management").close method. boto3 documentation

# close method definition

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

create_task

Instructs one or more devices to start a task, such as unlocking or rebooting.

Type annotations and code completion for boto3.client("snow-device-management").create_task method. boto3 documentation

# create_task method definition

def create_task(
    self,
    *,
    command: CommandTypeDef,  # (1)
    targets: Sequence[str],
    clientToken: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateTaskOutputTypeDef:  # (2)
    ...

1. See CommandTypeDef
2. See CreateTaskOutputTypeDef

# create_task method usage example with argument unpacking

kwargs: CreateTaskInputRequestTypeDef = {  # (1)
    "command": ...,
    "targets": ...,
}

parent.create_task(**kwargs)

1. See CreateTaskInputRequestTypeDef

describe_device

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

Type annotations and code completion for boto3.client("snow-device-management").describe_device method. boto3 documentation

# describe_device method definition

def describe_device(
    self,
    *,
    managedDeviceId: str,
) -> DescribeDeviceOutputTypeDef:  # (1)
    ...

1. See DescribeDeviceOutputTypeDef

# describe_device method usage example with argument unpacking

kwargs: DescribeDeviceInputRequestTypeDef = {  # (1)
    "managedDeviceId": ...,
}

parent.describe_device(**kwargs)

1. See DescribeDeviceInputRequestTypeDef

describe_device_ec2_instances

Checks the current state of the Amazon EC2 instances.

Type annotations and code completion for boto3.client("snow-device-management").describe_device_ec2_instances method. boto3 documentation

# describe_device_ec2_instances method definition

def describe_device_ec2_instances(
    self,
    *,
    instanceIds: Sequence[str],
    managedDeviceId: str,
) -> DescribeDeviceEc2OutputTypeDef:  # (1)
    ...

1. See DescribeDeviceEc2OutputTypeDef

# describe_device_ec2_instances method usage example with argument unpacking

kwargs: DescribeDeviceEc2InputRequestTypeDef = {  # (1)
    "instanceIds": ...,
    "managedDeviceId": ...,
}

parent.describe_device_ec2_instances(**kwargs)

1. See DescribeDeviceEc2InputRequestTypeDef

describe_execution

Checks the status of a remote task running on one or more target devices.

Type annotations and code completion for boto3.client("snow-device-management").describe_execution method. boto3 documentation

# describe_execution method definition

def describe_execution(
    self,
    *,
    managedDeviceId: str,
    taskId: str,
) -> DescribeExecutionOutputTypeDef:  # (1)
    ...

1. See DescribeExecutionOutputTypeDef

# describe_execution method usage example with argument unpacking

kwargs: DescribeExecutionInputRequestTypeDef = {  # (1)
    "managedDeviceId": ...,
    "taskId": ...,
}

parent.describe_execution(**kwargs)

1. See DescribeExecutionInputRequestTypeDef

describe_task

Checks the metadata for a given task on a device.

Type annotations and code completion for boto3.client("snow-device-management").describe_task method. boto3 documentation

# describe_task method definition

def describe_task(
    self,
    *,
    taskId: str,
) -> DescribeTaskOutputTypeDef:  # (1)
    ...

1. See DescribeTaskOutputTypeDef

# describe_task method usage example with argument unpacking

kwargs: DescribeTaskInputRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.describe_task(**kwargs)

1. See DescribeTaskInputRequestTypeDef

generate_presigned_url

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

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

list_device_resources

Returns a list of the Amazon Web Services resources available for a device.

Type annotations and code completion for boto3.client("snow-device-management").list_device_resources method.