SnowDeviceManagementClient#
Index > SnowDeviceManagement > SnowDeviceManagementClient
Auto-generated documentation for SnowDeviceManagement type annotations stubs module types-aiobotocore-snow-device-management.
SnowDeviceManagementClient#
Type annotations and code completion for session.create_client("snow-device-management")
boto3 documentation
SnowDeviceManagementClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_snow_device_management.client import SnowDeviceManagementClient
session = get_session()
async with session.create_client("snow-device-management") as client:
client: SnowDeviceManagementClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("snow-device-management").exceptions
structure.
SnowDeviceManagementClient.exceptions usage example
async with session.create_client("snow-device-management") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
SnowDeviceManagementClient usage type checking example
from types_aiobotocore_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 session.create_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 session.create_client("snow-device-management").cancel_task
method.
boto3 documentation
# cancel_task method definition
await def cancel_task(
self,
*,
taskId: str,
) -> CancelTaskOutputTypeDef: # (1)
...
# cancel_task method usage example with argument unpacking
kwargs: CancelTaskInputRequestTypeDef = { # (1)
"taskId": ...,
}
parent.cancel_task(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("snow-device-management").close
method.
boto3 documentation
# close method definition
await 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 session.create_client("snow-device-management").create_task
method.
boto3 documentation
# create_task method definition
await def create_task(
self,
*,
command: CommandTypeDef, # (1)
targets: Sequence[str],
clientToken: str = ...,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateTaskOutputTypeDef: # (2)
...
# create_task method usage example with argument unpacking
kwargs: CreateTaskInputRequestTypeDef = { # (1)
"command": ...,
"targets": ...,
}
parent.create_task(**kwargs)
describe_device#
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
Type annotations and code completion for session.create_client("snow-device-management").describe_device
method.
boto3 documentation
# describe_device method definition
await def describe_device(
self,
*,
managedDeviceId: str,
) -> DescribeDeviceOutputTypeDef: # (1)
...
# describe_device method usage example with argument unpacking
kwargs: DescribeDeviceInputRequestTypeDef = { # (1)
"managedDeviceId": ...,
}
parent.describe_device(**kwargs)
describe_device_ec2_instances#
Checks the current state of the Amazon EC2 instances.
Type annotations and code completion for session.create_client("snow-device-management").describe_device_ec2_instances
method.
boto3 documentation
# describe_device_ec2_instances method definition
await def describe_device_ec2_instances(
self,
*,
instanceIds: Sequence[str],
managedDeviceId: str,
) -> DescribeDeviceEc2OutputTypeDef: # (1)
...
# describe_device_ec2_instances method usage example with argument unpacking
kwargs: DescribeDeviceEc2InputRequestTypeDef = { # (1)
"instanceIds": ...,
"managedDeviceId": ...,
}
parent.describe_device_ec2_instances(**kwargs)
describe_execution#
Checks the status of a remote task running on one or more target devices.
Type annotations and code completion for session.create_client("snow-device-management").describe_execution
method.
boto3 documentation
# describe_execution method definition
await def describe_execution(
self,
*,
managedDeviceId: str,
taskId: str,
) -> DescribeExecutionOutputTypeDef: # (1)
...
# describe_execution method usage example with argument unpacking
kwargs: DescribeExecutionInputRequestTypeDef = { # (1)
"managedDeviceId": ...,
"taskId": ...,
}
parent.describe_execution(**kwargs)
describe_task#
Checks the metadata for a given task on a device.
Type annotations and code completion for session.create_client("snow-device-management").describe_task
method.
boto3 documentation
# describe_task method definition
await def describe_task(
self,
*,
taskId: str,
) -> DescribeTaskOutputTypeDef: # (1)
...
# describe_task method usage example with argument unpacking
kwargs: DescribeTaskInputRequestTypeDef = { # (1)
"taskId": ...,
}
parent.describe_task(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("snow-device-management").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("snow-device-management").list_device_resources
method.
boto3 documentation
# list_device_resources method definition
await def list_device_resources(
self,
*,
managedDeviceId: str,
maxResults: int = ...,
nextToken: str = ...,
type: str = ...,
) -> ListDeviceResourcesOutputTypeDef: # (1)
...
# list_device_resources method usage example with argument unpacking
kwargs: ListDeviceResourcesInputRequestTypeDef = { # (1)
"managedDeviceId": ...,
}
parent.list_device_resources(**kwargs)
list_devices#
Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.
Type annotations and code completion for session.create_client("snow-device-management").list_devices
method.
boto3 documentation
# list_devices method definition
await def list_devices(
self,
*,
jobId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListDevicesOutputTypeDef: # (1)
...
# list_devices method usage example with argument unpacking
kwargs: ListDevicesInputRequestTypeDef = { # (1)
"jobId": ...,
}
parent.list_devices(**kwargs)
list_executions#
Returns the status of tasks for one or more target devices.
Type annotations and code completion for session.create_client("snow-device-management").list_executions
method.
boto3 documentation
# list_executions method definition
await def list_executions(
self,
*,
taskId: str,
maxResults: int = ...,
nextToken: str = ...,
state: ExecutionStateType = ..., # (1)
) -> ListExecutionsOutputTypeDef: # (2)
...
# list_executions method usage example with argument unpacking
kwargs: ListExecutionsInputRequestTypeDef = { # (1)
"taskId": ...,
}
parent.list_executions(**kwargs)
list_tags_for_resource#
Returns a list of tags for a managed device or task.
Type annotations and code completion for session.create_client("snow-device-management").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_tasks#
Returns a list of tasks that can be filtered by state.
Type annotations and code completion for session.create_client("snow-device-management").list_tasks
method.
boto3 documentation
# list_tasks method definition
await def list_tasks(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
state: TaskStateType = ..., # (1)
) -> ListTasksOutputTypeDef: # (2)
...
- See TaskStateType
- See ListTasksOutputTypeDef
# list_tasks method usage example with argument unpacking
kwargs: ListTasksInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_tasks(**kwargs)
tag_resource#
Adds or replaces tags on a device or task.
Type annotations and code completion for session.create_client("snow-device-management").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes a tag from a device or task.
Type annotations and code completion for session.create_client("snow-device-management").untag_resource
method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("snow-device-management").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> SnowDeviceManagementClient:
...
__aexit__#
Type annotations and code completion for session.create_client("snow-device-management").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("snow-device-management").get_paginator
method with overloads.
client.get_paginator("list_device_resources")
-> ListDeviceResourcesPaginatorclient.get_paginator("list_devices")
-> ListDevicesPaginatorclient.get_paginator("list_executions")
-> ListExecutionsPaginatorclient.get_paginator("list_tasks")
-> ListTasksPaginator