@aws-sdk/client-snow-device-management 3.379.1 → 3.385.0

package/dist-types/models/models_0.d.ts

@@ -31,6 +31,7 @@ export type AttachmentStatus = (typeof AttachmentStatus)[keyof typeof Attachment
  */
 export interface CancelTaskInput {
     /**
+     * @public
      * <p>The ID of the task that you are attempting to cancel. You can retrieve a task ID by using
      *       the <code>ListTasks</code> operation.</p>
      */
@@ -41,6 +42,7 @@ export interface CancelTaskInput {
  */
 export interface CancelTaskOutput {
     /**
+     * @public
      * <p>The ID of the task that you are attempting to cancel.</p>
      */
     taskId?: string;
@@ -103,22 +105,27 @@ export declare class ValidationException extends __BaseException {
  */
 export interface Capacity {
     /**
+     * @public
      * <p>The name of the type of capacity, such as memory.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The unit of measure for the type of capacity.</p>
      */
     unit?: string;
     /**
+     * @public
      * <p>The total capacity on the device.</p>
      */
     total?: number;
     /**
+     * @public
      * <p>The amount of capacity used on the device.</p>
      */
     used?: number;
     /**
+     * @public
      * <p>The amount of capacity available for use on the device.</p>
      */
     available?: number;
@@ -145,6 +152,7 @@ export type Command = Command.RebootMember | Command.UnlockMember | Command.$Unk
  */
 export declare namespace Command {
     /**
+     * @public
      * <p>Unlocks the device.</p>
      */
     interface UnlockMember {
@@ -153,6 +161,7 @@ export declare namespace Command {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Reboots the device.</p>
      */
     interface RebootMember {
@@ -160,6 +169,9 @@ export declare namespace Command {
         reboot: Reboot;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         unlock?: never;
         reboot?: never;
@@ -178,10 +190,12 @@ export declare namespace Command {
  */
 export interface CpuOptions {
     /**
+     * @public
      * <p>The number of cores that the CPU can use.</p>
      */
     coreCount?: number;
     /**
+     * @public
      * <p>The number of threads per core in the CPU.</p>
      */
     threadsPerCore?: number;
@@ -191,23 +205,28 @@ export interface CpuOptions {
  */
 export interface CreateTaskInput {
     /**
+     * @public
      * <p>A list of managed device IDs.</p>
      */
     targets: string[] | undefined;
     /**
+     * @public
      * <p>The task to be performed. Only one task is executed on a device at a time.</p>
      */
     command: Command | undefined;
     /**
+     * @public
      * <p>A description of the task and its targets.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>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. </p>
      */
     tags?: Record<string, string>;
     /**
+     * @public
      * <p>A token ensuring that the action is called only once with the specified details.</p>
      */
     clientToken?: string;
@@ -217,10 +236,12 @@ export interface CreateTaskInput {
  */
 export interface CreateTaskOutput {
     /**
+     * @public
      * <p>The ID of the task that you created.</p>
      */
     taskId?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the task that you created.</p>
      */
     taskArn?: string;
@@ -242,6 +263,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
  */
 export interface DescribeDeviceInput {
     /**
+     * @public
      * <p>The ID of the device that you are checking the information of.</p>
      */
     managedDeviceId: string | undefined;
@@ -292,32 +314,39 @@ export type PhysicalConnectorType = (typeof PhysicalConnectorType)[keyof typeof
  */
 export interface PhysicalNetworkInterface {
     /**
+     * @public
      * <p>The physical network interface ID.</p>
      */
     physicalNetworkInterfaceId?: string;
     /**
+     * @public
      * <p>The
      *       physical
      *       connector type.</p>
      */
     physicalConnectorType?: PhysicalConnectorType | string;
     /**
+     * @public
      * <p>A value that describes whether the IP address is dynamic or persistent.</p>
      */
     ipAddressAssignment?: IpAddressAssignment | string;
     /**
+     * @public
      * <p>The IP address of the device.</p>
      */
     ipAddress?: string;
     /**
+     * @public
      * <p>The netmask used to divide the IP address into subnets.</p>
      */
     netmask?: string;
     /**
+     * @public
      * <p>The default gateway of the device.</p>
      */
     defaultGateway?: string;
     /**
+     * @public
      * <p>The MAC address of the device.</p>
      */
     macAddress?: string;
@@ -328,14 +357,17 @@ export interface PhysicalNetworkInterface {
  */
 export interface SoftwareInformation {
     /**
+     * @public
      * <p>The version of the software currently installed on the device.</p>
      */
     installedVersion?: string;
     /**
+     * @public
      * <p>The version of the software being installed on the device.</p>
      */
     installingVersion?: string;
     /**
+     * @public
      * <p>The state of the software that is installed or that is being installed on the
      *       device.</p>
      */
@@ -346,49 +378,60 @@ export interface SoftwareInformation {
  */
 export interface DescribeDeviceOutput {
     /**
+     * @public
      * <p>When the device last contacted the Amazon Web Services Cloud. Indicates that the device is
      *       online.</p>
      */
     lastReachedOutAt?: Date;
     /**
+     * @public
      * <p>When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache
      *       was refreshed.</p>
      */
     lastUpdatedAt?: Date;
     /**
+     * @public
      * <p>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. </p>
      */
     tags?: Record<string, string>;
     /**
+     * @public
      * <p>The ID of the device that you checked the information for.</p>
      */
     managedDeviceId?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the device.</p>
      */
     managedDeviceArn?: string;
     /**
+     * @public
      * <p>The type of Amazon Web Services Snow Family device.</p>
      */
     deviceType?: string;
     /**
+     * @public
      * <p>The ID of the job used when ordering the device.</p>
      */
     associatedWithJob?: string;
     /**
+     * @public
      * <p>The current state of the device.</p>
      */
     deviceState?: UnlockState | string;
     /**
+     * @public
      * <p>The network interfaces available on the device.</p>
      */
     physicalNetworkInterfaces?: PhysicalNetworkInterface[];
     /**
+     * @public
      * <p>The hardware specifications of the device. </p>
      */
     deviceCapacities?: Capacity[];
     /**
+     * @public
      * <p>The software installed on the device.</p>
      */
     software?: SoftwareInformation;
@@ -398,10 +441,12 @@ export interface DescribeDeviceOutput {
  */
 export interface DescribeDeviceEc2Input {
     /**
+     * @public
      * <p>The ID of the managed device.</p>
      */
     managedDeviceId: string | undefined;
     /**
+     * @public
      * <p>A list of instance IDs associated with the managed device.</p>
      */
     instanceIds: string[] | undefined;
@@ -413,18 +458,22 @@ export interface DescribeDeviceEc2Input {
  */
 export interface EbsInstanceBlockDevice {
     /**
+     * @public
      * <p>When the attachment was initiated.</p>
      */
     attachTime?: Date;
     /**
+     * @public
      * <p>A value that indicates whether the volume is deleted on instance termination.</p>
      */
     deleteOnTermination?: boolean;
     /**
+     * @public
      * <p>The attachment state.</p>
      */
     status?: AttachmentStatus | string;
     /**
+     * @public
      * <p>The ID of the Amazon EBS volume.</p>
      */
     volumeId?: string;
@@ -435,10 +484,12 @@ export interface EbsInstanceBlockDevice {
  */
 export interface InstanceBlockDeviceMapping {
     /**
+     * @public
      * <p>The block device name.</p>
      */
     deviceName?: string;
     /**
+     * @public
      * <p>The parameters used to automatically set up Amazon Elastic Block Store (Amazon EBS)
      *       volumes when the instance is launched. </p>
      */
@@ -450,10 +501,12 @@ export interface InstanceBlockDeviceMapping {
  */
 export interface SecurityGroupIdentifier {
     /**
+     * @public
      * <p>The security group ID.</p>
      */
     groupId?: string;
     /**
+     * @public
      * <p>The security group name.</p>
      */
     groupName?: string;
@@ -480,6 +533,7 @@ export type InstanceStateName = (typeof InstanceStateName)[keyof typeof Instance
  */
 export interface InstanceState {
     /**
+     * @public
      * <p>The state of the instance as a 16-bit unsigned integer. </p>
      *          <p>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
@@ -525,6 +579,7 @@ export interface InstanceState {
      */
     code?: number;
     /**
+     * @public
      * <p>The current
      *       state
      *       of the instance.</p>
@@ -539,55 +594,68 @@ export interface InstanceState {
  */
 export interface Instance {
     /**
+     * @public
      * <p>The ID of the AMI used to launch the instance.</p>
      */
     imageId?: string;
     /**
+     * @public
      * <p>The Amazon Machine Image (AMI) launch index, which you can use to find this instance in
      *       the launch group. </p>
      */
     amiLaunchIndex?: number;
     /**
+     * @public
      * <p>The ID of the instance.</p>
      */
     instanceId?: string;
     /**
+     * @public
      * <p>The description of the current state of an instance.</p>
      */
     state?: InstanceState;
     /**
+     * @public
      * <p>The instance type.</p>
      */
     instanceType?: string;
     /**
+     * @public
      * <p>The private IPv4 address assigned to the instance.</p>
      */
     privateIpAddress?: string;
     /**
+     * @public
      * <p>The public IPv4 address assigned to the instance.</p>
      */
     publicIpAddress?: string;
     /**
+     * @public
      * <p>When the instance was created.</p>
      */
     createdAt?: Date;
     /**
+     * @public
      * <p>When the instance was last updated.</p>
      */
     updatedAt?: Date;
     /**
+     * @public
      * <p>Any block device mapping entries for the instance.</p>
      */
     blockDeviceMappings?: InstanceBlockDeviceMapping[];
     /**
+     * @public
      * <p>The security groups for the instance.</p>
      */
     securityGroups?: SecurityGroupIdentifier[];
     /**
+     * @public
      * <p>The CPU options for the instance.</p>
      */
     cpuOptions?: CpuOptions;
     /**
+     * @public
      * <p>The device name of the root device volume (for example, <code>/dev/sda1</code>). </p>
      */
     rootDeviceName?: string;
@@ -598,10 +666,12 @@ export interface Instance {
  */
 export interface InstanceSummary {
     /**
+     * @public
      * <p>A structure containing details about the instance.</p>
      */
     instance?: Instance;
     /**
+     * @public
      * <p>When the instance summary was last updated.</p>
      */
     lastUpdatedAt?: Date;
@@ -611,6 +681,7 @@ export interface InstanceSummary {
  */
 export interface DescribeDeviceEc2Output {
     /**
+     * @public
      * <p>A list of structures containing information about each instance. </p>
      */
     instances?: InstanceSummary[];
@@ -620,10 +691,12 @@ export interface DescribeDeviceEc2Output {
  */
 export interface DescribeExecutionInput {
     /**
+     * @public
      * <p>The ID of the task that the action is describing.</p>
      */
     taskId: string | undefined;
     /**
+     * @public
      * <p>The ID of the managed device.</p>
      */
     managedDeviceId: string | undefined;
@@ -650,26 +723,32 @@ export type ExecutionState = (typeof ExecutionState)[keyof typeof ExecutionState
  */
 export interface DescribeExecutionOutput {
     /**
+     * @public
      * <p>The ID of the task being executed on the device.</p>
      */
     taskId?: string;
     /**
+     * @public
      * <p>The ID of the execution.</p>
      */
     executionId?: string;
     /**
+     * @public
      * <p>The ID of the managed device that the task is being executed on.</p>
      */
     managedDeviceId?: string;
     /**
+     * @public
      * <p>The current state of the execution.</p>
      */
     state?: ExecutionState | string;
     /**
+     * @public
      * <p>When the execution began.</p>
      */
     startedAt?: Date;
     /**
+     * @public
      * <p>When the status of the execution was last updated.</p>
      */
     lastUpdatedAt?: Date;
@@ -679,6 +758,7 @@ export interface DescribeExecutionOutput {
  */
 export interface DescribeTaskInput {
     /**
+     * @public
      * <p>The ID of the task to be described.</p>
      */
     taskId: string | undefined;
@@ -701,38 +781,47 @@ export type TaskState = (typeof TaskState)[keyof typeof TaskState];
  */
 export interface DescribeTaskOutput {
     /**
+     * @public
      * <p>The ID of the task.</p>
      */
     taskId?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the task.</p>
      */
     taskArn?: string;
     /**
+     * @public
      * <p>The managed devices that the task was sent to.</p>
      */
     targets?: string[];
     /**
+     * @public
      * <p>The current state of the task.</p>
      */
     state?: TaskState | string;
     /**
+     * @public
      * <p>When the <code>CreateTask</code> operation was called.</p>
      */
     createdAt?: Date;
     /**
+     * @public
      * <p>When the state of the task was last updated.</p>
      */
     lastUpdatedAt?: Date;
     /**
+     * @public
      * <p>When the task was completed.</p>
      */
     completedAt?: Date;
     /**
+     * @public
      * <p>The description provided of the task and managed devices.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>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.</p>
      */
@@ -744,18 +833,22 @@ export interface DescribeTaskOutput {
  */
 export interface DeviceSummary {
     /**
+     * @public
      * <p>The ID of the device.</p>
      */
     managedDeviceId?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the device.</p>
      */
     managedDeviceArn?: string;
     /**
+     * @public
      * <p>The ID of the job used to order the device.</p>
      */
     associatedWithJob?: string;
     /**
+     * @public
      * <p>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.</p>
      */
@@ -766,18 +859,22 @@ export interface DeviceSummary {
  */
 export interface ListExecutionsInput {
     /**
+     * @public
      * <p>The ID of the task.</p>
      */
     taskId: string | undefined;
     /**
+     * @public
      * <p>A structure used to filter the tasks by their current state.</p>
      */
     state?: ExecutionState | string;
     /**
+     * @public
      * <p>The maximum number of tasks to list per page.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>A pagination token to continue to the next page of tasks.</p>
      */
     nextToken?: string;
@@ -788,18 +885,22 @@ export interface ListExecutionsInput {
  */
 export interface ExecutionSummary {
     /**
+     * @public
      * <p>The ID of the task.</p>
      */
     taskId?: string;
     /**
+     * @public
      * <p>The ID of the execution.</p>
      */
     executionId?: string;
     /**
+     * @public
      * <p>The ID of the managed device that the task is being executed on.</p>
      */
     managedDeviceId?: string;
     /**
+     * @public
      * <p>The state of the execution.</p>
      */
     state?: ExecutionState | string;
@@ -809,11 +910,13 @@ export interface ExecutionSummary {
  */
 export interface ListExecutionsOutput {
     /**
+     * @public
      * <p>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.</p>
      */
     executions?: ExecutionSummary[];
     /**
+     * @public
      * <p>A pagination token to continue to the next page of executions.</p>
      */
     nextToken?: string;
@@ -823,18 +926,22 @@ export interface ListExecutionsOutput {
  */
 export interface ListDeviceResourcesInput {
     /**
+     * @public
      * <p>The ID of the managed device that you are listing the resources of.</p>
      */
     managedDeviceId: string | undefined;
     /**
+     * @public
      * <p>A structure used to filter the results by type of resource.</p>
      */
     type?: string;
     /**
+     * @public
      * <p>The maximum number of resources per page.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>A pagination token to continue to the next page of results.</p>
      */
     nextToken?: string;
@@ -845,14 +952,17 @@ export interface ListDeviceResourcesInput {
  */
 export interface ResourceSummary {
     /**
+     * @public
      * <p>The resource type.</p>
      */
     resourceType: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the resource.</p>
      */
     arn?: string;
     /**
+     * @public
      * <p>The ID of the resource.</p>
      */
     id?: string;
@@ -862,10 +972,12 @@ export interface ResourceSummary {
  */
 export interface ListDeviceResourcesOutput {
     /**
+     * @public
      * <p>A structure defining the resource's type, Amazon Resource Name (ARN), and ID.</p>
      */
     resources?: ResourceSummary[];
     /**
+     * @public
      * <p>A pagination token to continue to the next page of results.</p>
      */
     nextToken?: string;
@@ -875,14 +987,17 @@ export interface ListDeviceResourcesOutput {
  */
 export interface ListDevicesInput {
     /**
+     * @public
      * <p>The ID of the job used to order the device.</p>
      */
     jobId?: string;
     /**
+     * @public
      * <p>The maximum number of devices to list per page.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>A pagination token to continue to the next page of results.</p>
      */
     nextToken?: string;
@@ -892,10 +1007,12 @@ export interface ListDevicesInput {
  */
 export interface ListDevicesOutput {
     /**
+     * @public
      * <p>A list of device structures that contain information about the device.</p>
      */
     devices?: DeviceSummary[];
     /**
+     * @public
      * <p>A pagination token to continue to the next page of devices.</p>
      */
     nextToken?: string;
@@ -905,6 +1022,7 @@ export interface ListDevicesOutput {
  */
 export interface ListTagsForResourceInput {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the device or task.</p>
      */
     resourceArn: string | undefined;
@@ -914,6 +1032,7 @@ export interface ListTagsForResourceInput {
  */
 export interface ListTagsForResourceOutput {
     /**
+     * @public
      * <p>The list of tags for the device or task.</p>
      */
     tags?: Record<string, string>;
@@ -923,14 +1042,17 @@ export interface ListTagsForResourceOutput {
  */
 export interface ListTasksInput {
     /**
+     * @public
      * <p>A structure used to filter the list of tasks.</p>
      */
     state?: TaskState | string;
     /**
+     * @public
      * <p>The maximum number of tasks per page.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>A pagination token to continue to the next page of tasks.</p>
      */
     nextToken?: string;
@@ -941,18 +1063,22 @@ export interface ListTasksInput {
  */
 export interface TaskSummary {
     /**
+     * @public
      * <p>The task ID.</p>
      */
     taskId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the task.</p>
      */
     taskArn?: string;
     /**
+     * @public
      * <p>The state of the task assigned to one or many devices.</p>
      */
     state?: TaskState | string;
     /**
+     * @public
      * <p>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.</p>
      */
@@ -963,10 +1089,12 @@ export interface TaskSummary {
  */
 export interface ListTasksOutput {
     /**
+     * @public
      * <p>A list of task structures containing details about each task.</p>
      */
     tasks?: TaskSummary[];
     /**
+     * @public
      * <p>A pagination token to continue to the next page of tasks.</p>
      */
     nextToken?: string;
@@ -976,10 +1104,12 @@ export interface ListTasksOutput {
  */
 export interface TagResourceInput {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the device or task.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>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.</p>
      */
@@ -990,10 +1120,12 @@ export interface TagResourceInput {
  */
 export interface UntagResourceInput {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the device or task.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>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.</p>
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-snow-device-management",
   "description": "AWS SDK for JavaScript Snow Device Management Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.385.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.385.0",
+    "@aws-sdk/credential-provider-node": "3.385.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",