SDK for PHP 3.x

AWS Snow Device Management 2021-08-04

Client: Aws\SnowDeviceManagement\SnowDeviceManagementClient
Service ID: snow-device-management
Version: 2021-08-04

This page describes the parameters and results for the operations of the AWS Snow Device Management (2021-08-04), and shows how to use the Aws\SnowDeviceManagement\SnowDeviceManagementClient object to call the described operations. This documentation is specific to the 2021-08-04 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelTask ( array $params = [] )
Sends a cancel request for a specified task.
CreateTask ( array $params = [] )
Instructs one or more devices to start a task, such as unlocking or rebooting.
DescribeDevice ( array $params = [] )
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
DescribeDeviceEc2Instances ( array $params = [] )
Checks the current state of the Amazon EC2 instances.
DescribeExecution ( array $params = [] )
Checks the status of a remote task running on one or more target devices.
DescribeTask ( array $params = [] )
Checks the metadata for a given task on a device.
ListDeviceResources ( array $params = [] )
Returns a list of the Amazon Web Services resources available for a device.
ListDevices ( array $params = [] )
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.
ListExecutions ( array $params = [] )
Returns the status of tasks for one or more target devices.
ListTagsForResource ( array $params = [] )
Returns a list of tags for a managed device or task.
ListTasks ( array $params = [] )
Returns a list of tasks that can be filtered by state.
TagResource ( array $params = [] )
Adds or replaces tags on a device or task.
UntagResource ( array $params = [] )
Removes a tag from a device or task.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListDeviceResources
ListDevices
ListExecutions
ListTasks

Operations

CancelTask 

$result = $client->cancelTask([/* ... */]);
$promise = $client->cancelTaskAsync([/* ... */]);

Sends a cancel request for a specified task. You can cancel a task only if it's still in a QUEUED state. Tasks that are already running can't be cancelled.

A task might still run if it's processed from the queue before the CancelTask operation changes the task's state.

Parameter Syntax

$result = $client->cancelTask([
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
taskId
Required: Yes
Type: string

The ID of the task that you are attempting to cancel. You can retrieve a task ID by using the ListTasks operation.

Result Syntax

[
    'taskId' => '<string>',
]

Result Details

Members
taskId
Type: string

The ID of the task that you are attempting to cancel.

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

An unexpected error occurred while processing the request.

ResourceNotFoundException:

The request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient access to perform this action.

CreateTask 

$result = $client->createTask([/* ... */]);
$promise = $client->createTaskAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createTask([
    'clientToken' => '<string>',
    'command' => [ // REQUIRED
        'reboot' => [
        ],
        'unlock' => [
        ],
    ],
    'description' => '<string>',
    'tags' => ['<string>', ...],
    'targets' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A token ensuring that the action is called only once with the specified details.

command
Required: Yes
Type: Command structure

The task to be performed. Only one task is executed on a device at a time.

description
Type: string

A description of the task and its targets.

tags
Type: Associative array of custom strings keys (String) to strings

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

targets
Required: Yes
Type: Array of strings

A list of managed device IDs.

Result Syntax

[
    'taskArn' => '<string>',
    'taskId' => '<string>',
]

Result Details

Members
taskArn
Type: string

The Amazon Resource Name (ARN) of the task that you created.

taskId
Type: string

The ID of the task that you created.

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

An unexpected error occurred while processing the request.

ResourceNotFoundException:

The request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient access to perform this action.

DescribeDevice 

$result = $client->describeDevice([/* ... */]);
$promise = $client->describeDeviceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDevice([
    'managedDeviceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
managedDeviceId
Required: Yes
Type: string

The ID of the device that you are checking the information of.

Result Syntax

[
    'associatedWithJob' => '<string>',
    'deviceCapacities' => [
        [
            'available' => <integer>,
            'name' => '<string>',
            'total' => <integer>,
            'unit' => '<string>',
            'used' => <integer>,
        ],
        // ...
    ],
    'deviceState' => 'UNLOCKED|LOCKED|UNLOCKING',
    'deviceType' => '<string>',
    'lastReachedOutAt' => <DateTime>,
    'lastUpdatedAt' => <DateTime>,
    'managedDeviceArn' => '<string>',
    'managedDeviceId' => '<string>',
    'physicalNetworkInterfaces' => [
        [
            'defaultGateway' => '<string>',
            'ipAddress' => '<string>',
            'ipAddressAssignment' => 'DHCP|STATIC',
            'macAddress' => '<string>',
            'netmask' => '<string>',
            'physicalConnectorType' => 'RJ45|SFP_PLUS|QSFP|RJ45_2|WIFI',
            'physicalNetworkInterfaceId' => '<string>',
        ],
        // ...
    ],
    'software' => [
        'installState' => '<string>',
        'installedVersion' => '<string>',
        'installingVersion' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
associatedWithJob
Type: string

The ID of the job used when ordering the device.

deviceCapacities
Type: Array of Capacity structures

The hardware specifications of the device.

deviceState
Type: string

The current state of the device.

deviceType
Type: string

The type of Amazon Web Services Snow Family device.

lastReachedOutAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.

lastUpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.

managedDeviceArn
Type: string

The Amazon Resource Name (ARN) of the device.

managedDeviceId
Type: string

The ID of the device that you checked the information for.

physicalNetworkInterfaces
Type: Array of PhysicalNetworkInterface structures

The network interfaces available on the device.

software
Type: SoftwareInformation structure

The software installed on the device.

tags
Type: Associative array of custom strings keys (String) to strings

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

An unexpected error occurred while processing the request.

ResourceNotFoundException:

The request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient access to perform this action.

DescribeDeviceEc2Instances 

$result = $client->describeDeviceEc2Instances([/* ... */]);
$promise = $client->describeDeviceEc2InstancesAsync([/* ... */]);

Checks the current state of the Amazon EC2 instances. The output is similar to describeDevice, but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields.

Parameter Syntax

$result = $client->describeDeviceEc2Instances([
    'instanceIds' => ['<string>', ...], // REQUIRED
    'managedDeviceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
instanceIds
Required: Yes
Type: Array of strings

A list of instance IDs associated with the managed device.

managedDeviceId
Required: Yes
Type: string

The ID of the managed device.

Result Syntax

[
    'instances' => [
        [
            'instance' => [
                'amiLaunchIndex' => <integer>,
                'blockDeviceMappings' => [
                    [
                        'deviceName' => '<string>',
                        'ebs' => [
                            'attachTime' => <DateTime>,
                            'deleteOnTermination' => true || false,
                            'status' => 'ATTACHING|ATTACHED|DETACHING|DETACHED',
                            'volumeId' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'cpuOptions' => [
                    'coreCount' => <integer>,
                    'threadsPerCore' => <integer>,
                ],
                'createdAt' => <DateTime>,
                'imageId' => '<string>',
                'instanceId' => '<string>',
                'instanceType' => '<string>',
                'privateIpAddress' => '<string>',
                'publicIpAddress' => '<string>',
                'rootDeviceName' => '<string>',
                'securityGroups' => [
                    [
                        'groupId' => '<string>',
                        'groupName' => '<string>',
                    ],
                    // ...
                ],
                'state' => [
                    'code' => <integer>,
                    'name' => 'PENDING|RUNNING|SHUTTING_DOWN|TERMINATED|STOPPING|STOPPED',
                ],
                'updatedAt' => <DateTime>,
            ],
            'lastUpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
instances
Type: Array of InstanceSummary structures

A list of structures containing information about each instance.

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

An unexpected error occurred while processing the request.

ResourceNotFoundException:

The request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient access to perform this action.

DescribeExecution 

$result = $client->describeExecution([/* ... */]);
$promise = $client->describeExecutionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeExecution([
    'managedDeviceId' => '<string>', // REQUIRED
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
managedDeviceId
Required: Yes
Type: string

The ID of the managed device.

taskId
Required: Yes
Type: string

The ID of the task that the action is describing.

Result Syntax

[
    'executionId' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'managedDeviceId' => '<string>',
    'startedAt' => <DateTime>,
    'state' => 'QUEUED|IN_PROGRESS|CANCELED|FAILED|SUCCEEDED|REJECTED|TIMED_OUT',
    'taskId' => '<string>',
]

Result Details

Members
executionId
Type: string

The ID of the execution.

lastUpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the status of the execution was last updated.

managedDeviceId
Type: string

The ID of the managed device that the task is being executed on.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the execution began.

state
Type: string

The current state of the execution.

taskId
Type: string

The ID of the task being executed on the device.

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

An unexpected error occurred while processing the request.

ResourceNotFoundException:

The request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient access to perform this action.

DescribeTask 

$result = $client->describeTask([/* ... */]);
$promise = $client->describeTaskAsync([/* ... */]);

Checks the metadata for a given task on a device.

Parameter Syntax

$result = $client->describeTask([
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
taskId
Required: Yes
Type: string

The ID of the task to be described.

Result Syntax

[
    'completedAt' => <DateTime>,
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'state' => 'IN_PROGRESS|CANCELED|COMPLETED',
    'tags' => ['<string>', ...],
    'targets' => ['<string>', ...],
    'taskArn' => '<string>',
    'taskId' => '<string>',
]

Result Details

Members
completedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the task was completed.

createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the CreateTask operation was called.

description
Type: string

The description provided of the task and managed devices.

lastUpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the state of the task was last updated.

state
Type: string

The current state of the task.

tags
Type: Associative array of custom strings keys (String) to strings

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

targets
Type: Array of strings

The managed devices that the task was sent to.

taskArn
Type: string

The Amazon Resource Name (ARN) of the task.

taskId
Type: string

The ID of the task.

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

An unexpected error occurred while processing the request.

ResourceNotFoundException:

The request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient access to perform this action.

ListDeviceResources 

$result = $client->listDeviceResources([/* ... */]);
$promise = $client->listDeviceResourcesAsync([/* ... */]);

Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.

Parameter Syntax

$result = $client->listDeviceResources([
    'managedDeviceId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'type' => '<string>',
]);

Parameter Details

Members
managedDeviceId
Required: Yes
Type: string

The ID of the managed device that you are listing the resources of.

maxResults
Type: int

The maximum number of resources per page.

nextToken
Type: string

A pagination token to continue to the next page of results.

type
Type: string

A structure used to filter the results by type of resource.

Result Syntax

[
    'nextToken' => '<string>',
    'resources' => [
        [
            'arn' => '<string>',
            'id' => '<string>',
            'resourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

A pagination token to continue to the next page of results.

resources
Type: Array of ResourceSummary structures

A structure defining the resource's type, Amazon Resource Name (ARN), and ID.

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

An unexpected error occurred while processing the request.

ResourceNotFoundException:

The request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient access to perform this action.

ListDevices 

$result = $client->listDevices([/* ... */]);
$promise = $client->listDevicesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listDevices([
    'jobId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
jobId
Type: string

The ID of the job used to order the device.

maxResults
Type: int

The maximum number of devices to list per page.

nextToken
Type: string

A pagination token to continue to the next page of results.

Result Syntax

[
    'devices' => [
        [
            'associatedWithJob' => '<string>',
            'managedDeviceArn' => '<string>',
            'managedDeviceId' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
devices
Type: Array of DeviceSummary structures

A list of device structures that contain information about the device.

nextToken
Type: string

A pagination token to continue to the next page of devices.

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient access to perform this action.

ListExecutions 

$result = $client->listExecutions([/* ... */]);
$promise = $client->listExecutionsAsync([/* ... */]);

Returns the status of tasks for one or more target devices.

Parameter Syntax

$result = $client->listExecutions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'state' => 'QUEUED|IN_PROGRESS|CANCELED|FAILED|SUCCEEDED|REJECTED|TIMED_OUT',
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of tasks to list per page.

nextToken
Type: string

A pagination token to continue to the next page of tasks.

state
Type: string

A structure used to filter the tasks by their current state.

taskId
Required: Yes
Type: string

The ID of the task.

Result Syntax

[
    'executions' => [
        [
            'executionId' => '<string>',
            'managedDeviceId' => '<string>',
            'state' => 'QUEUED|IN_PROGRESS|CANCELED|FAILED|SUCCEEDED|REJECTED|TIMED_OUT',
            'taskId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
executions
Type: Array of ExecutionSummary structures

A list of executions. Each execution contains the task ID, the device that the task is executing on, the execution ID, and the status of the execution.

nextToken
Type: string

A pagination token to continue to the next page of executions.

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

An unexpected error occurred while processing the request.

ResourceNotFoundException:

The request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient access to perform this action.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of tags for a managed device or task.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the device or task.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (String) to strings

The list of tags for the device or task.

Errors

InternalServerException:

An unexpected error occurred while processing the request.

ResourceNotFoundException:

The request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListTasks 

$result = $client->listTasks([/* ... */]);
$promise = $client->listTasksAsync([/* ... */]);

Returns a list of tasks that can be filtered by state.

Parameter Syntax

$result = $client->listTasks([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'state' => 'IN_PROGRESS|CANCELED|COMPLETED',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of tasks per page.

nextToken
Type: string

A pagination token to continue to the next page of tasks.

state
Type: string

A structure used to filter the list of tasks.

Result Syntax

[
    'nextToken' => '<string>',
    'tasks' => [
        [
            'state' => 'IN_PROGRESS|CANCELED|COMPLETED',
            'tags' => ['<string>', ...],
            'taskArn' => '<string>',
            'taskId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

A pagination token to continue to the next page of tasks.

tasks
Type: Array of TaskSummary structures

A list of task structures containing details about each task.

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient access to perform this action.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or replaces tags on a device or task.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the device or task.

tags
Required: Yes
Type: Associative array of custom strings keys (String) to strings

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An unexpected error occurred while processing the request.

ResourceNotFoundException:

The request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag from a device or task.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the device or task.

tagKeys
Required: Yes
Type: Array of strings

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An unexpected error occurred while processing the request.

ResourceNotFoundException:

The request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Shapes

AccessDeniedException

Description

You don't have sufficient access to perform this action.

Members
message
Required: Yes
Type: string

Capacity

Description

The physical capacity of the Amazon Web Services Snow Family device.

Members
available
Type: long (int|float)

The amount of capacity available for use on the device.

name
Type: string

The name of the type of capacity, such as memory.

total
Type: long (int|float)

The total capacity on the device.

unit
Type: string

The unit of measure for the type of capacity.

used
Type: long (int|float)

The amount of capacity used on the device.

Command

Description

The command given to the device to execute.

Members
reboot
Type: Reboot structure

Reboots the device.

unlock
Type: Unlock structure

Unlocks the device.

CpuOptions

Description

The options for how a device's CPU is configured.

Members
coreCount
Type: int

The number of cores that the CPU can use.

threadsPerCore
Type: int

The number of threads per core in the CPU.

DeviceSummary

Description

Identifying information about the device.

Members
associatedWithJob
Type: string

The ID of the job used to order the device.

managedDeviceArn
Type: string

The Amazon Resource Name (ARN) of the device.

managedDeviceId
Type: string

The ID of the device.

tags
Type: Associative array of custom strings keys (String) to strings

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

EbsInstanceBlockDevice

Description

Describes a parameter used to set up an Amazon Elastic Block Store (Amazon EBS) volume in a block device mapping.

Members
attachTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the attachment was initiated.

deleteOnTermination
Type: boolean

A value that indicates whether the volume is deleted on instance termination.

status
Type: string

The attachment state.

volumeId
Type: string

The ID of the Amazon EBS volume.

ExecutionSummary

Description

The summary of a task execution on a specified device.

Members
executionId
Type: string

The ID of the execution.

managedDeviceId
Type: string

The ID of the managed device that the task is being executed on.

state
Type: string

The state of the execution.

taskId
Type: string

The ID of the task.

Instance

Description

The description of an instance. Currently, Amazon EC2 instances are the only supported instance type.

Members
amiLaunchIndex
Type: int

The Amazon Machine Image (AMI) launch index, which you can use to find this instance in the launch group.

blockDeviceMappings
Type: Array of InstanceBlockDeviceMapping structures

Any block device mapping entries for the instance.

cpuOptions
Type: CpuOptions structure

The CPU options for the instance.

createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the instance was created.

imageId
Type: string

The ID of the AMI used to launch the instance.

instanceId
Type: string

The ID of the instance.

instanceType
Type: string

The instance type.

privateIpAddress
Type: string

The private IPv4 address assigned to the instance.

publicIpAddress
Type: string

The public IPv4 address assigned to the instance.

rootDeviceName
Type: string

The device name of the root device volume (for example, /dev/sda1).

securityGroups
Type: Array of SecurityGroupIdentifier structures

The security groups for the instance.

state
Type: InstanceState structure

The description of the current state of an instance.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the instance was last updated.

InstanceBlockDeviceMapping

Description

The description of a block device mapping.

Members
deviceName
Type: string

The block device name.

ebs
Type: EbsInstanceBlockDevice structure

The parameters used to automatically set up Amazon Elastic Block Store (Amazon EBS) volumes when the instance is launched.

InstanceState

Description

The description of the current state of an instance.

Members
code
Type: int

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for the instance state code are all in the range of the low byte. These values are:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

name
Type: string

The current state of the instance.

InstanceSummary

Description

The details about the instance.

Members
instance
Type: Instance structure

A structure containing details about the instance.

lastUpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the instance summary was last updated.

InternalServerException

Description

An unexpected error occurred while processing the request.

Members
message
Required: Yes
Type: string

PhysicalNetworkInterface

Description

The details about the physical network interface for the device.

Members
defaultGateway
Type: string

The default gateway of the device.

ipAddress
Type: string

The IP address of the device.

ipAddressAssignment
Type: string

A value that describes whether the IP address is dynamic or persistent.

macAddress
Type: string

The MAC address of the device.

netmask
Type: string

The netmask used to divide the IP address into subnets.

physicalConnectorType
Type: string

The physical connector type.

physicalNetworkInterfaceId
Type: string

The physical network interface ID.

Reboot

Description

A structure used to reboot the device.

Members

ResourceNotFoundException

Description

The request references a resource that doesn't exist.

Members
message
Required: Yes
Type: string

ResourceSummary

Description

A summary of a resource available on the device.

Members
arn
Type: string

The Amazon Resource Name (ARN) of the resource.

id
Type: string

The ID of the resource.

resourceType
Required: Yes
Type: string

The resource type.

SecurityGroupIdentifier

Description

Information about the device's security group.

Members
groupId
Type: string

The security group ID.

groupName
Type: string

The security group name.

ServiceQuotaExceededException

Description

The request would cause a service quota to be exceeded.

Members
message
Required: Yes
Type: string

SoftwareInformation

Description

Information about the software on the device.

Members
installState
Type: string

The state of the software that is installed or that is being installed on the device.

installedVersion
Type: string

The version of the software currently installed on the device.

installingVersion
Type: string

The version of the software being installed on the device.

TaskSummary

Description

Information about the task assigned to one or many devices.

Members
state
Type: string

The state of the task assigned to one or many devices.

tags
Type: Associative array of custom strings keys (String) to strings

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

taskArn
Type: string

The Amazon Resource Name (ARN) of the task.

taskId
Required: Yes
Type: string

The task ID.

ThrottlingException

Description

The request was denied due to request throttling.

Members
message
Required: Yes
Type: string

Unlock

Description

A structure used to unlock a device.

Members

ValidationException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members
message
Required: Yes
Type: string