{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.storagegateway#ActivateGateway": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#ActivateGatewayInput" }, "output": { "target": "com.amazonaws.storagegateway#ActivateGatewayOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "
Activates the gateway you previously deployed on your host. In the activation process,\n you specify information such as the Amazon Web Services Region that you want to use for\n storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot\n schedule window, an activation key, and a name for your gateway. The activation process\n also associates your gateway with your account. For more information, see UpdateGatewayInformation.
\nYou must turn on the gateway VM before you can activate your gateway.
\nYour gateway activation key. You can obtain the activation key by sending an HTTP GET\n request with redirects enabled to the gateway IP address (port 80). The redirect URL\n returned in the response provides you the activation key for your gateway in the query\n string parameter activationKey. It may also include other activation-related\n parameters, however, these are merely defaults -- the arguments you pass to the\n ActivateGateway API call determine the actual configuration of your\n gateway.
For more information, see Getting activation\n key in the Storage Gateway User Guide.
", "smithy.api#required": {} } }, "GatewayName": { "target": "com.amazonaws.storagegateway#GatewayName", "traits": { "smithy.api#documentation": "The name you configured for your gateway.
", "smithy.api#required": {} } }, "GatewayTimezone": { "target": "com.amazonaws.storagegateway#GatewayTimezone", "traits": { "smithy.api#documentation": "A value that indicates the time zone you want to set for the gateway. The time zone is\n of the format \"GMT\", \"GMT-hr:mm\", or \"GMT+hr:mm\". For example, GMT indicates Greenwich Mean\n Time without any offset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00\n indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for\n scheduling snapshots and your gateway's maintenance schedule.
", "smithy.api#required": {} } }, "GatewayRegion": { "target": "com.amazonaws.storagegateway#RegionId", "traits": { "smithy.api#documentation": "A value that indicates the Amazon Web Services Region where you want to store your data.\n The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region\n as the Amazon Web Services Region in your Host header in the request. For more\n information about available Amazon Web Services Regions and endpoints for Storage Gateway, see \n Storage Gateway endpoints and quotas in the Amazon Web Services\n General Reference.
Valid Values: See \n Storage Gateway endpoints and quotas in the Amazon Web Services\n General Reference.\n \n
", "smithy.api#required": {} } }, "GatewayType": { "target": "com.amazonaws.storagegateway#GatewayType", "traits": { "smithy.api#documentation": "A value that defines the type of gateway to activate. The type specified is critical to\n all later functions of the gateway and cannot be changed after activation. The default\n value is CACHED.
Amazon FSx File Gateway is no longer available to new customers. Existing\n customers of FSx File Gateway can continue to use the service normally. For\n capabilities similar to FSx File Gateway, visit this blog post.
\nValid Values: STORED | CACHED | VTL\n | FILE_S3 |\n FILE_FSX_SMB\n
The value that indicates the type of tape drive to use for tape gateway. This field is\n optional.
\nValid Values: IBM-ULT3580-TD5\n
The value that indicates the type of medium changer to use for tape gateway. This field\n is optional.
\nValid Values: STK-L700 | AWS-Gateway-VTL |\n IBM-03584L32-0402\n
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value\n pair.
\nValid characters for key and value are letters, spaces, and numbers that can be\n represented in UTF-8 format, and the following special characters: + - = . _ : / @. The\n maximum length of a tag's key is 128 characters, and the maximum length for a\n tag's value is 256 characters.
\nA JSON object containing one or more of the following fields:
\nStorage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It\n is a string made of information such as your account, gateway name, and Amazon Web Services Region. This ARN is used to reference the gateway in other API operations as\n well as resource-based authorization.
\nFor gateways activated prior to September 02, 2015, the gateway ARN contains the\n gateway name rather than the gateway ID. Changing the name of the gateway has no effect\n on the gateway ARN.
\nConfigures one or more gateway local disks as cache for a gateway. This operation is\n only supported in the cached volume, tape, and file gateway type (see How Storage Gateway works (architecture).
\nIn the request, you specify the gateway Amazon Resource Name (ARN) to which you want to\n add cache, and one or more disk IDs that you want to configure as cache.
", "smithy.api#examples": [ { "title": "To add a cache", "documentation": "The following example shows a request that activates a gateway-stored volume.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:03:00.0-scsi-0:0:1:0" ] }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" } } ] } }, "com.amazonaws.storagegateway#AddCacheInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "DiskIds": { "target": "com.amazonaws.storagegateway#DiskIds", "traits": { "smithy.api#documentation": "An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#AddCacheOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#AddTagsToResource": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#AddTagsToResourceInput" }, "output": { "target": "com.amazonaws.storagegateway#AddTagsToResourceOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to the specified resource. You use tags to add metadata to\n resources, which you can use to categorize these resources. For example, you can categorize\n resources by purpose, owner, environment, or team. Each tag consists of a key and a value,\n which you define. You can add tags to the following Storage Gateway resources:
\nStorage gateways of all types
\nStorage volumes
\nVirtual tapes
\nNFS and SMB file shares
\nFile System associations
\nYou can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes\n that are recovered to a new gateway maintain their tags.
", "smithy.api#examples": [ { "title": "To add tags to resource", "documentation": "Adds one or more tags to the specified resource.", "input": { "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", "Tags": [ { "Key": "Dev Gatgeway Region", "Value": "East Coast" } ] }, "output": { "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" } } ] } }, "com.amazonaws.storagegateway#AddTagsToResourceInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.storagegateway#ResourceARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource you want to add tags to.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { "smithy.api#documentation": "The key-value pair that represents the tag you want to add to the resource. The value\n can be an empty string.
\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nAddTagsToResourceInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#AddTagsToResourceOutput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.storagegateway#ResourceARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource you want to add tags to.
" } } }, "traits": { "smithy.api#documentation": "AddTagsToResourceOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#AddUploadBuffer": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#AddUploadBufferInput" }, "output": { "target": "com.amazonaws.storagegateway#AddUploadBufferOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Configures one or more gateway local disks as upload buffer for a specified gateway.\n This operation is supported for the stored volume, cached volume, and tape gateway\n types.
\nIn the request, you specify the gateway Amazon Resource Name (ARN) to which you want to\n add upload buffer, and one or more disk IDs that you want to configure as upload\n buffer.
", "smithy.api#examples": [ { "title": "To add upload buffer on local disk", "documentation": "Configures one or more gateway local disks as upload buffer for a specified gateway.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:03:00.0-scsi-0:0:1:0" ] }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" } } ] } }, "com.amazonaws.storagegateway#AddUploadBufferInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "DiskIds": { "target": "com.amazonaws.storagegateway#DiskIds", "traits": { "smithy.api#documentation": "An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#AddUploadBufferOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#AddWorkingStorage": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#AddWorkingStorageInput" }, "output": { "target": "com.amazonaws.storagegateway#AddWorkingStorageOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Configures one or more gateway local disks as working storage for a gateway. This\n operation is only supported in the stored volume gateway type. This operation is deprecated\n in cached volume API version 20120630. Use AddUploadBuffer\n instead.
\nWorking storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume\n gateway.
\nIn the request, you specify the gateway Amazon Resource Name (ARN) to which you want to\n add working storage, and one or more disk IDs that you want to configure as working\n storage.
", "smithy.api#examples": [ { "title": "To add storage on local disk", "documentation": "Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.)", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:03:00.0-scsi-0:0:1:0" ] }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" } } ] } }, "com.amazonaws.storagegateway#AddWorkingStorageInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "DiskIds": { "target": "com.amazonaws.storagegateway#DiskIds", "traits": { "smithy.api#documentation": "An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing one or more of the following fields:
\nA JSON object containing the Amazon Resource Name (ARN) of the gateway for which working\n storage was configured.
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#AssignTapePool": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#AssignTapePoolInput" }, "output": { "target": "com.amazonaws.storagegateway#AssignTapePoolOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in\n the S3 storage class that is associated with the pool. When you use your backup application\n to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or\n S3 Glacier Deep Archive) that corresponds to the pool.
" } }, "com.amazonaws.storagegateway#AssignTapePoolInput": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the\n tape pool.
", "smithy.api#required": {} } }, "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { "smithy.api#documentation": "The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
", "smithy.api#required": {} } }, "BypassGovernanceRetention": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Set permissions to bypass governance retention. If the lock type of the archived tape is\n Governance, the tape's archived age is not older than\n RetentionLockInDays, and the user does not already have\n BypassGovernanceRetention, setting this to TRUE enables the user to bypass\n the retention lock. This parameter is set to true by default for calls from the\n console.
Valid values: TRUE | FALSE\n
The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape\n pool.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#AssociateFileSystem": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#AssociateFileSystemInput" }, "output": { "target": "com.amazonaws.storagegateway#AssociateFileSystemOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Associate an Amazon FSx file system with the FSx File Gateway. After the\n association process is complete, the file shares on the Amazon FSx file system are\n available for access through the gateway. This operation only supports the FSx File Gateway\n type.
" } }, "com.amazonaws.storagegateway#AssociateFileSystemInput": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.storagegateway#DomainUserName", "traits": { "smithy.api#documentation": "The user name of the user credential that has permission to access the root share D$ of\n the Amazon FSx file system. The user account must belong to the Amazon FSx\n delegated admin user group.
", "smithy.api#required": {} } }, "Password": { "target": "com.amazonaws.storagegateway#DomainUserPassword", "traits": { "smithy.api#documentation": "The password of the user credential.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.storagegateway#ClientToken", "traits": { "smithy.api#documentation": "A unique string value that you supply that is used by the FSx File Gateway to ensure\n idempotent file system association creation.
", "smithy.api#required": {} } }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "LocationARN": { "target": "com.amazonaws.storagegateway#FileSystemLocationARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with\n the FSx File Gateway.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { "smithy.api#documentation": "A list of up to 50 tags that can be assigned to the file system association. Each tag is\n a key-value pair.
" } }, "AuditDestinationARN": { "target": "com.amazonaws.storagegateway#AuditDestinationARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the storage used for the audit logs.
" } }, "CacheAttributes": { "target": "com.amazonaws.storagegateway#CacheAttributes" }, "EndpointNetworkConfiguration": { "target": "com.amazonaws.storagegateway#EndpointNetworkConfiguration", "traits": { "smithy.api#documentation": "Specifies the network configuration information for the gateway associated with the\n Amazon FSx file system.
\nIf multiple file systems are associated with this gateway, this parameter's\n IpAddresses field is required.
The ARN of the newly created file system association.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#AttachVolume": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#AttachVolumeInput" }, "output": { "target": "com.amazonaws.storagegateway#AttachVolumeOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Connects a volume to an iSCSI connection and then attaches the volume to the specified\n gateway. Detaching and attaching a volume enables you to recover your data from one gateway\n to a different gateway without creating a snapshot. It also makes it easier to move your\n volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.
" } }, "com.amazonaws.storagegateway#AttachVolumeInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway that you want to attach the volume\n to.
", "smithy.api#required": {} } }, "TargetName": { "target": "com.amazonaws.storagegateway#TargetName", "traits": { "smithy.api#documentation": "The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
" } }, "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.
", "smithy.api#required": {} } }, "NetworkInterfaceId": { "target": "com.amazonaws.storagegateway#NetworkInterfaceId", "traits": { "smithy.api#documentation": "The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4\n and IPv6 addresses. Use DescribeGatewayInformation to get a list of the\n network interfaces available on a gateway.
\nValid Values: A valid IP address.
", "smithy.api#required": {} } }, "DiskId": { "target": "com.amazonaws.storagegateway#DiskId", "traits": { "smithy.api#documentation": "The unique device ID or other distinguishing data that identifies the local disk used to\n create the volume. This value is only required when you are attaching a stored\n volume.
" } } }, "traits": { "smithy.api#documentation": "AttachVolumeInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#AttachVolumeOutput": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume that was attached to the gateway.
" } }, "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for\n the initiator that was used to connect to the target.
" } } }, "traits": { "smithy.api#documentation": "AttachVolumeOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#AuditDestinationARN": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.storagegateway#Authentication": { "type": "string", "traits": { "smithy.api#documentation": "The authentication method of the file share. The default is\n ActiveDirectory.
Valid Values: ActiveDirectory | GuestAccess\n
An automatic tape creation policy consists of a list of automatic tape creation rules.\n This returns the rules that determine when and how to automatically create new\n tapes.
" } }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#documentation": "Information about the gateway's automatic tape creation policies, including the\n automatic tape creation rules and the gateway that is using the policies.
" } }, "com.amazonaws.storagegateway#AutomaticTapeCreationPolicyInfos": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#AutomaticTapeCreationPolicyInfo" } }, "com.amazonaws.storagegateway#AutomaticTapeCreationRule": { "type": "structure", "members": { "TapeBarcodePrefix": { "target": "com.amazonaws.storagegateway#TapeBarcodePrefix", "traits": { "smithy.api#documentation": "A prefix that you append to the barcode of the virtual tape that you are creating. This\n prefix makes the barcode unique.
\nThe prefix must be 1-4 characters in length and must be one of the uppercase letters\n from A to Z.
\nThe ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the Amazon S3 storage class that is associated with the pool.\n When you use your backup application to eject the tape, the tape is archived directly into\n the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the\n pool.
", "smithy.api#required": {} } }, "TapeSizeInBytes": { "target": "com.amazonaws.storagegateway#TapeSize", "traits": { "smithy.api#documentation": "The size, in bytes, of the virtual tape capacity.
", "smithy.api#required": {} } }, "MinimumNumTapes": { "target": "com.amazonaws.storagegateway#MinimumNumTapes", "traits": { "smithy.api#documentation": "The minimum number of available virtual tapes that the gateway maintains at all times.\n If the number of tapes on the gateway goes below this value, the gateway creates as many\n new tapes as are needed to have MinimumNumTapes on the gateway. For more\n information about automatic tape creation, see Creating Tapes Automatically.
Set to true to indicate that tapes are to be archived as\n write-once-read-many (WORM). Set to false when WORM is not enabled for\n tapes.
An automatic tape creation policy consists of automatic tape creation rules where each\n rule defines when and how to create new tapes. For more information about automatic tape\n creation, see Creating Tapes Automatically.
" } }, "com.amazonaws.storagegateway#AutomaticTapeCreationRules": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#AutomaticTapeCreationRule" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.storagegateway#AutomaticUpdatePolicy": { "type": "enum", "members": { "ALL_VERSIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL_VERSIONS" } }, "EMERGENCY_VERSIONS_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMERGENCY_VERSIONS_ONLY" } } } }, "com.amazonaws.storagegateway#AvailabilityMonitorTestStatus": { "type": "enum", "members": { "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } } } }, "com.amazonaws.storagegateway#BandwidthDownloadRateLimit": { "type": "long", "traits": { "smithy.api#range": { "min": 102400 } } }, "com.amazonaws.storagegateway#BandwidthRateLimitInterval": { "type": "structure", "members": { "StartHourOfDay": { "target": "com.amazonaws.storagegateway#HourOfDay", "traits": { "smithy.api#documentation": "The hour of the day to start the bandwidth rate limit interval.
", "smithy.api#required": {} } }, "StartMinuteOfHour": { "target": "com.amazonaws.storagegateway#MinuteOfHour", "traits": { "smithy.api#documentation": " The minute of the hour to start the bandwidth rate limit interval. The interval begins\n at the start of that minute. To begin an interval exactly at the start of the hour, use the\n value 0.
The hour of the day to end the bandwidth rate limit interval.
", "smithy.api#required": {} } }, "EndMinuteOfHour": { "target": "com.amazonaws.storagegateway#MinuteOfHour", "traits": { "smithy.api#documentation": "The minute of the hour to end the bandwidth rate limit interval.
\n The bandwidth rate limit interval ends at the end of the minute. To end an interval\n at the end of an hour, use the value 59.
The days of the week component of the bandwidth rate limit interval, represented as\n ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.
", "smithy.api#required": {} } }, "AverageUploadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthUploadRateLimit", "traits": { "smithy.api#documentation": "The average upload rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the upload rate limit is not set.
\nFor Tape Gateway and Volume Gateway, the minimum value is 51200.
This field is required for S3 File Gateway, and the minimum value is\n 104857600.
The average download rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the download rate limit is not\n set.
\nS3 File Gateway does not support this feature.
\nDescribes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule\n consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval\n defines a period of time on one or more days of the week, during which bandwidth rate\n limits are specified for uploading, downloading, or both.
\nFSx File Gateway does not support this feature.
\nRefreshes a file share's cache by using Time To Live (TTL). TTL is the length of\n time since the last refresh after which access to the directory would cause the file\n gateway to first refresh that directory's contents from the Amazon S3 bucket\n or Amazon FSx file system. The TTL duration is in seconds.
\nValid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
" } } }, "traits": { "smithy.api#documentation": "The refresh cache information for the file share or FSx file systems.
" } }, "com.amazonaws.storagegateway#CacheReportARN": { "type": "string", "traits": { "smithy.api#length": { "min": 50, "max": 500 } } }, "com.amazonaws.storagegateway#CacheReportFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.storagegateway#CacheReportFilterName", "traits": { "smithy.api#documentation": "The parameter name for a filter that determines which files are included or excluded\n from a cache report.
\n\n Valid Names:\n
\nUploadFailureReason | UploadState
", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.storagegateway#CacheReportFilterValues", "traits": { "smithy.api#documentation": "The parameter value for a filter that determines which files are included or excluded\n from a cache report.
\n\n Valid UploadFailureReason Values:\n
\n InaccessibleStorageClass | InvalidObjectState |\n ObjectMissing | S3AccessDenied\n
\n Valid UploadState Values:\n
\n FailingUpload\n
A list of filter parameters and associated values that determine which files are\n included or excluded from a cache report created by a StartCacheReport\n request. Multiple instances of the same filter parameter are combined with an OR operation,\n while different parameters are combined with an AND operation.
The Amazon Resource Name (ARN) of the cache report you want to describe.
" } }, "CacheReportStatus": { "target": "com.amazonaws.storagegateway#CacheReportStatus", "traits": { "smithy.api#documentation": "The status of the specified cache report.
" } }, "ReportCompletionPercent": { "target": "com.amazonaws.storagegateway#ReportCompletionPercent", "traits": { "smithy.api#documentation": "The percentage of the report generation process that has been completed at time of\n inquiry.
" } }, "EndTime": { "target": "com.amazonaws.storagegateway#Time", "traits": { "smithy.api#documentation": "The time at which the gateway stopped generating the cache report.
" } }, "Role": { "target": "com.amazonaws.storagegateway#Role" }, "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN" }, "LocationARN": { "target": "com.amazonaws.storagegateway#LocationARN", "traits": { "smithy.api#documentation": "The ARN of the Amazon S3 bucket location where the cache report is saved.
" } }, "StartTime": { "target": "com.amazonaws.storagegateway#Time", "traits": { "smithy.api#documentation": "The time at which the gateway started generating the cache report.
" } }, "InclusionFilters": { "target": "com.amazonaws.storagegateway#CacheReportFilterList", "traits": { "smithy.api#documentation": "The list of filters and parameters that determine which files are included in the\n report.
" } }, "ExclusionFilters": { "target": "com.amazonaws.storagegateway#CacheReportFilterList", "traits": { "smithy.api#documentation": "The list of filters and parameters that determine which files are excluded from the\n report.
" } }, "ReportName": { "target": "com.amazonaws.storagegateway#CacheReportName", "traits": { "smithy.api#documentation": "The file name of the completed cache report object stored in Amazon S3.
" } }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { "smithy.api#documentation": "The list of key/value tags associated with the report.
" } } }, "traits": { "smithy.api#documentation": "Contains all informational fields associated with a cache report. Includes name, ARN,\n tags, status, progress, filters, start time, and end time.
" } }, "com.amazonaws.storagegateway#CacheReportList": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#CacheReportInfo" } }, "com.amazonaws.storagegateway#CacheReportName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.storagegateway#CacheReportStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } } } }, "com.amazonaws.storagegateway#CacheStaleTimeoutInSeconds": { "type": "integer" }, "com.amazonaws.storagegateway#CachediSCSIVolume": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the storage volume.
" } }, "VolumeId": { "target": "com.amazonaws.storagegateway#VolumeId", "traits": { "smithy.api#documentation": "The unique identifier of the volume, e.g., vol-AE4B946D.
" } }, "VolumeType": { "target": "com.amazonaws.storagegateway#VolumeType", "traits": { "smithy.api#documentation": "One of the VolumeType enumeration values that describes the type of the volume.
" } }, "VolumeStatus": { "target": "com.amazonaws.storagegateway#VolumeStatus", "traits": { "smithy.api#documentation": "One of the VolumeStatus values that indicates the state of the storage volume.
" } }, "VolumeAttachmentStatus": { "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", "traits": { "smithy.api#documentation": "A value that indicates whether a storage volume is attached to or detached from a\n gateway. For more information, see Moving\n your volumes to a different gateway.
" } }, "VolumeSizeInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The size, in bytes, of the volume capacity.
" } }, "VolumeProgress": { "target": "com.amazonaws.storagegateway#DoubleObject", "traits": { "smithy.api#documentation": "Represents the percentage complete if the volume is restoring or bootstrapping that\n represents the percent of data transferred. This field does not appear in the response if\n the cached volume is not restoring or bootstrapping.
" } }, "SourceSnapshotId": { "target": "com.amazonaws.storagegateway#SnapshotId", "traits": { "smithy.api#documentation": "If the cached volume was created from a snapshot, this field contains the snapshot ID\n used, e.g., snap-78e22663. Otherwise, this field is not included.
" } }, "VolumeiSCSIAttributes": { "target": "com.amazonaws.storagegateway#VolumeiSCSIAttributes", "traits": { "smithy.api#documentation": "An VolumeiSCSIAttributes object that represents a collection of iSCSI\n attributes for one stored volume.
" } }, "CreatedDate": { "target": "com.amazonaws.storagegateway#CreatedDate", "traits": { "smithy.api#documentation": "The date the volume was created. Volumes created prior to March 28, 2017 don\u2019t have this\n timestamp.
" } }, "VolumeUsedInBytes": { "target": "com.amazonaws.storagegateway#VolumeUsedInBytes", "traits": { "smithy.api#documentation": "The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.
\nIf you use a delete tool that overwrites the data on your volume with random data,\n your usage will not be reduced. This is because the random data is not compressible. If\n you want to reduce the amount of billed storage on your volume, we recommend overwriting\n your files with zeros to compress the data to a negligible amount of actual\n storage.
\nThe name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
" } } }, "traits": { "smithy.api#documentation": "Describes an iSCSI cached volume.
" } }, "com.amazonaws.storagegateway#CachediSCSIVolumes": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#CachediSCSIVolume" } }, "com.amazonaws.storagegateway#CancelArchival": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#CancelArchivalInput" }, "output": { "target": "com.amazonaws.storagegateway#CancelArchivalOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving\n process is initiated. This operation is only supported in the tape gateway type.
", "smithy.api#examples": [ { "title": "To cancel virtual tape archiving", "documentation": "Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" }, "output": { "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" } } ] } }, "com.amazonaws.storagegateway#CancelArchivalInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving\n for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "CancelArchivalInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#CancelArchivalOutput": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape for which archiving was\n canceled.
" } } }, "traits": { "smithy.api#documentation": "CancelArchivalOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CancelCacheReport": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#CancelCacheReportInput" }, "output": { "target": "com.amazonaws.storagegateway#CancelCacheReportOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Cancels generation of a specified cache report. You can use this operation to manually\n cancel an IN-PROGRESS report for any reason. This action changes the report status from\n IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you\n attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an\n error.
" } }, "com.amazonaws.storagegateway#CancelCacheReportInput": { "type": "structure", "members": { "CacheReportARN": { "target": "com.amazonaws.storagegateway#CacheReportARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cache report you want to cancel.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#CancelCacheReportOutput": { "type": "structure", "members": { "CacheReportARN": { "target": "com.amazonaws.storagegateway#CacheReportARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cache report you want to cancel.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CancelRetrieval": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#CancelRetrievalInput" }, "output": { "target": "com.amazonaws.storagegateway#CancelRetrievalOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after\n the retrieval process is initiated. The virtual tape is returned to the VTS. This operation\n is only supported in the tape gateway type.
", "smithy.api#examples": [ { "title": "To cancel virtual tape retrieval", "documentation": "Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" }, "output": { "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" } } ] } }, "com.amazonaws.storagegateway#CancelRetrievalInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval\n for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "CancelRetrievalInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#CancelRetrievalOutput": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape for which retrieval was\n canceled.
" } } }, "traits": { "smithy.api#documentation": "CancelRetrievalOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CaseSensitivity": { "type": "enum", "members": { "ClientSpecified": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ClientSpecified" } }, "CaseSensitive": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CaseSensitive" } } } }, "com.amazonaws.storagegateway#ChapCredentials": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#ChapInfo" } }, "com.amazonaws.storagegateway#ChapInfo": { "type": "structure", "members": { "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume.
\nValid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" } }, "SecretToAuthenticateInitiator": { "target": "com.amazonaws.storagegateway#ChapSecret", "traits": { "smithy.api#documentation": "The secret key that the initiator (for example, the Windows client) must provide to\n participate in mutual CHAP with the target.
" } }, "InitiatorName": { "target": "com.amazonaws.storagegateway#IqnName", "traits": { "smithy.api#documentation": "The iSCSI initiator that connects to the target.
" } }, "SecretToAuthenticateTarget": { "target": "com.amazonaws.storagegateway#ChapSecret", "traits": { "smithy.api#documentation": "The secret key that the target must provide to participate in mutual CHAP with the\n initiator (e.g., Windows client).
" } } }, "traits": { "smithy.api#documentation": "Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports\n authentication between your gateway and iSCSI initiators.
" } }, "com.amazonaws.storagegateway#ChapSecret": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#sensitive": {} } }, "com.amazonaws.storagegateway#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 100 } } }, "com.amazonaws.storagegateway#CloudWatchLogGroupARN": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 562 } } }, "com.amazonaws.storagegateway#CreateCachediSCSIVolume": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#CreateCachediSCSIVolumeInput" }, "output": { "target": "com.amazonaws.storagegateway#CreateCachediSCSIVolumeOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Creates a cached volume on a specified cached volume gateway. This operation is only\n supported in the cached volume gateway type.
\nCache storage must be allocated to the gateway before you can create a cached volume.\n Use the AddCache operation to add cache storage to a gateway.
\nIn the request, you must specify the gateway, size of the volume in bytes, the iSCSI\n target name, an IP address on which to expose the target, and a unique client token. In\n response, the gateway creates the volume and returns information about it. This information\n includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that\n initiators can use to connect to the volume target.
\nOptionally, you can provide the ARN for an existing volume as the\n SourceVolumeARN for this cached volume, which creates an exact copy of the\n existing volume\u2019s latest recovery point. The VolumeSizeInBytes value must be\n equal to or larger than the size of the copied volume, in bytes.
The size of the volume in bytes.
", "smithy.api#required": {} } }, "SnapshotId": { "target": "com.amazonaws.storagegateway#SnapshotId", "traits": { "smithy.api#documentation": "The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new cached\n volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;\n otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API\n Reference.
" } }, "TargetName": { "target": "com.amazonaws.storagegateway#TargetName", "traits": { "smithy.api#documentation": "The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
", "smithy.api#required": {} } }, "SourceVolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The ARN for an existing volume. Specifying this ARN makes the new volume into an exact\n copy of the specified existing volume's latest recovery point. The\n VolumeSizeInBytes value for this new volume must be equal to or larger than\n the size of the existing volume, in bytes.
The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4\n and IPv6 addresses. Use DescribeGatewayInformation to get a list of the\n network interfaces available on a gateway.
\nValid Values: A valid IP address.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.storagegateway#ClientToken", "traits": { "smithy.api#documentation": "A unique identifier that you use to retry a request. If you retry a request, use the\n same ClientToken you specified in the initial request.
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value\n pair.
\nValid characters for key and value are letters, spaces, and numbers that you can\n represent in UTF-8 format, and the following special characters: + - = . _ : / @. The\n maximum length of a tag's key is 128 characters, and the maximum length for a\n tag's value is 256 characters.
\nThe Amazon Resource Name (ARN) of the configured volume.
" } }, "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that\n initiators can use to connect to the target.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CreateNFSFileShare": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#CreateNFSFileShareInput" }, "output": { "target": "com.amazonaws.storagegateway#CreateNFSFileShareOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Creates a Network File System (NFS) file share on an existing S3 File Gateway. In\n Storage Gateway, a file share is a file system mount point backed by Amazon S3\n cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation\n is only supported for S3 File Gateways.
\nS3 File gateway requires Security Token Service (Amazon Web Services STS) to be\n activated to enable you to create a file share. Make sure Amazon Web Services STS is\n activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If\n Amazon Web Services STS is not activated in the Amazon Web Services Region, activate\n it. For information about how to activate Amazon Web Services STS, see Activating and\n deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Identity and Access Management User Guide.
\nS3 File Gateways do not support creating hard or symbolic links on a file\n share.
\nA unique string value that you supply that is used by S3 File Gateway to ensure\n idempotent file share creation.
", "smithy.api#required": {} } }, "NFSFileShareDefaults": { "target": "com.amazonaws.storagegateway#NFSFileShareDefaults", "traits": { "smithy.api#documentation": "File share default values. Optional.
" } }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file\n share.
", "smithy.api#required": {} } }, "EncryptionType": { "target": "com.amazonaws.storagegateway#EncryptionType", "traits": { "smithy.api#documentation": "A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used\n for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric\n CMKs. This value must be set if KMSEncrypted is true, or if\n EncryptionType is SseKms or DsseKms.
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it\n accesses the underlying storage.
", "smithy.api#required": {} } }, "LocationARN": { "target": "com.amazonaws.storagegateway#LocationARN", "traits": { "smithy.api#documentation": "A custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).
\nYou can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.
\nBucket ARN:
\n\n arn:aws:s3:::amzn-s3-demo-bucket/prefix/\n
Access point ARN:
\n\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n
If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
\nAccess point alias:
\n\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n
The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a S3 File Gateway puts objects into. The default value is private.
The list of clients that are allowed to access the S3 File Gateway. The list must\n contain either valid IPv4/IPv6 addresses or valid CIDR blocks.
" } }, "Squash": { "target": "com.amazonaws.storagegateway#Squash", "traits": { "smithy.api#documentation": "A value that maps a user to anonymous user.
\nValid values are the following:
\n\n RootSquash: Only root is mapped to anonymous user.
\n NoSquash: No one is mapped to anonymous user.
\n AllSquash: Everyone is mapped to anonymous user.
A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.
Valid Values: true | false\n
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.
Valid Values: true | false\n
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true | false\n
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a\n key-value pair.
\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nThe name of the file share. Optional.
\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
A valid NFS file share name can only contain the following characters:\n a-z, A-Z,\n 0-9, -, ., and\n _.
Specifies refresh cache information for the file share.
" } }, "NotificationPolicy": { "target": "com.amazonaws.storagegateway#NotificationPolicy", "traits": { "smithy.api#documentation": "The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to\n Amazon S3.
\nThis parameter is required for NFS file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies the Region of the S3 bucket where the NFS file share stores files.
\nThis parameter is required for NFS file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nThe Amazon Resource Name (ARN) of the storage used for audit logs.
" } } }, "traits": { "smithy.api#documentation": "CreateNFSFileShareInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#CreateNFSFileShareOutput": { "type": "structure", "members": { "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the newly created file share.
" } } }, "traits": { "smithy.api#documentation": "CreateNFSFileShareOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CreateSMBFileShare": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#CreateSMBFileShareInput" }, "output": { "target": "com.amazonaws.storagegateway#CreateSMBFileShareOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In\n Storage Gateway, a file share is a file system mount point backed by Amazon S3\n cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation\n is only supported for S3 File Gateways.
\nS3 File Gateways require Security Token Service (Amazon Web Services STS) to be\n activated to enable you to create a file share. Make sure that Amazon Web Services STS\n is activated in the Amazon Web Services Region you are creating your S3 File Gateway in.\n If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate\n it. For information about how to activate Amazon Web Services STS, see Activating and\n deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Identity and Access Management User Guide.
\nFile gateways don't support creating hard or symbolic links on a file\n share.
\nA unique string value that you supply that is used by S3 File Gateway to ensure\n idempotent file share creation.
", "smithy.api#required": {} } }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The ARN of the S3 File Gateway on which you want to create a file share.
", "smithy.api#required": {} } }, "EncryptionType": { "target": "com.amazonaws.storagegateway#EncryptionType", "traits": { "smithy.api#documentation": "A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used\n for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric\n CMKs. This value must be set if KMSEncrypted is true, or if\n EncryptionType is SseKms or DsseKms.
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it\n accesses the underlying storage.
", "smithy.api#required": {} } }, "LocationARN": { "target": "com.amazonaws.storagegateway#LocationARN", "traits": { "smithy.api#documentation": "A custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).
\nYou can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.
\nBucket ARN:
\n\n arn:aws:s3:::amzn-s3-demo-bucket/prefix/\n
Access point ARN:
\n\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n
If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
\nAccess point alias:
\n\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n
The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a S3 File Gateway puts objects into. The default value is private.
A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.
Valid Values: true | false\n
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.
Valid Values: true | false\n
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true | false\n
Set this value to true to enable access control list (ACL) on the SMB file\n share. Set it to false to map file and directory permissions to the POSIX\n permissions.
For more information, see Using Windows ACLs to limit SMB file share\n access in the Amazon S3 File Gateway User\n Guide.
\nValid Values: true | false\n
The files and folders on this share will only be visible to users with read\n access.
" } }, "AdminUserList": { "target": "com.amazonaws.storagegateway#UserList", "traits": { "smithy.api#documentation": "A list of users or groups in the Active Directory that will be granted administrator\n privileges on the file share. These users can do all file operations as the super-user.\n Acceptable formats include: DOMAIN\\User1, user1,\n @group1, and @DOMAIN\\group1.
Use this option very carefully, because any user in this list can do anything they\n like on the file share, regardless of file permissions.
\nA list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats\n include: DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.
A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.
The Amazon Resource Name (ARN) of the storage used for audit logs.
" } }, "Authentication": { "target": "com.amazonaws.storagegateway#Authentication", "traits": { "smithy.api#documentation": "The authentication method that users use to access the file share. The default is\n ActiveDirectory.
Valid Values: ActiveDirectory | GuestAccess\n
The case of an object name in an Amazon S3 bucket. For\n ClientSpecified, the client determines the case sensitivity. For\n CaseSensitive, the gateway determines the case sensitivity. The default\n value is ClientSpecified.
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a\n key-value pair.
\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nThe name of the file share. Optional.
\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
A valid SMB file share name cannot contain the following characters:\n [,],#,;,<,>,:,\",\\,/,|,?,*,+,\n or ASCII control characters 1-31.
Specifies refresh cache information for the file share.
" } }, "NotificationPolicy": { "target": "com.amazonaws.storagegateway#NotificationPolicy", "traits": { "smithy.api#documentation": "The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to\n Amazon S3.
\nThis parameter is required for SMB file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies the Region of the S3 bucket where the SMB file share stores files.
\nThis parameter is required for SMB file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies whether opportunistic locking is enabled for the SMB file share.
\nEnabling opportunistic locking on case-sensitive shares is not recommended for\n workloads that involve access to files with the same name in different case.
\nValid Values: true | false\n
CreateSMBFileShareInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#CreateSMBFileShareOutput": { "type": "structure", "members": { "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the newly created file share.
" } } }, "traits": { "smithy.api#documentation": "CreateSMBFileShareOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CreateSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#CreateSnapshotInput" }, "output": { "target": "com.amazonaws.storagegateway#CreateSnapshotOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" }, { "target": "com.amazonaws.storagegateway#ServiceUnavailableError" } ], "traits": { "smithy.api#documentation": "Initiates a snapshot of a volume.
\nStorage Gateway provides the ability to back up point-in-time snapshots of your\n data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also\n import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute\n Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis.\n This API enables you to take an ad hoc snapshot. For more information, see Editing a\n snapshot schedule.
\nIn the CreateSnapshot request, you identify the volume by providing its\n Amazon Resource Name (ARN). You must also provide description for the snapshot. When\n Storage Gateway takes the snapshot of specified volume, the snapshot and\n description appears in the Storage Gateway console. In response, Storage Gateway\n returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or\n later use it when you want to create a volume from a snapshot. This operation is only\n supported in stored and cached volume gateway type.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n see DescribeSnapshots\n or DeleteSnapshot in the Amazon Elastic Compute Cloud API\n Reference.
\nVolume and snapshot IDs are changing to a longer length ID format. For more\n information, see the important note on the Welcome page.
\nInitiates a snapshot of a gateway from a volume recovery point. This operation is only\n supported in the cached volume gateway type.
\nA volume recovery point is a point in time at which all data of the volume is consistent\n and from which you can create a snapshot. To get a list of volume recovery point for cached\n volume gateway, use ListVolumeRecoveryPoints.
\nIn the CreateSnapshotFromVolumeRecoveryPoint request, you identify the\n volume by providing its Amazon Resource Name (ARN). You must also provide a description for\n the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and\n its description appear in the Storage Gateway console.\n In response, the gateway returns\n you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use\n it when you want to create a volume from a snapshot.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n see DescribeSnapshots\n or DeleteSnapshot in the Amazon Elastic Compute Cloud API\n Reference.
\nThe Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for\n specified VolumeARN.
", "smithy.api#required": {} } }, "SnapshotDescription": { "target": "com.amazonaws.storagegateway#SnapshotDescription", "traits": { "smithy.api#documentation": "Textual description of the snapshot that appears in the Amazon EC2 console, Elastic\n Block Store snapshots panel in the Description field, and\n in the Storage Gateway snapshot Details pane,\n Description field.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { "smithy.api#documentation": "A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.
\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nThe ID of the snapshot.
" } }, "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for\n specified VolumeARN.
" } }, "VolumeRecoveryPointTime": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "The time the volume was created from the recovery point.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CreateSnapshotInput": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume. Use the ListVolumes\n operation to return a list of gateway volumes.
", "smithy.api#required": {} } }, "SnapshotDescription": { "target": "com.amazonaws.storagegateway#SnapshotDescription", "traits": { "smithy.api#documentation": "Textual description of the snapshot that appears in the Amazon EC2 console, Elastic\n Block Store snapshots panel in the Description field, and\n in the Storage Gateway snapshot Details pane,\n Description field.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { "smithy.api#documentation": "A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.
\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nA JSON object containing one or more of the following fields:
\nThe Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
" } }, "SnapshotId": { "target": "com.amazonaws.storagegateway#SnapshotId", "traits": { "smithy.api#documentation": "The snapshot ID that is used to refer to the snapshot in future operations such as\n describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or\n creating a volume from a snapshot (CreateStorediSCSIVolume).
A JSON object containing the following fields:
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CreateStorediSCSIVolume": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#CreateStorediSCSIVolumeInput" }, "output": { "target": "com.amazonaws.storagegateway#CreateStorediSCSIVolumeOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Creates a volume on a specified gateway. This operation is only supported in the stored\n volume gateway type.
\nThe size of the volume to create is inferred from the disk size. You can choose to\n preserve existing data on the disk, create volume from an existing snapshot, or create an\n empty volume. If you choose to create an empty gateway volume, then any existing data on\n the disk is erased.
\nIn the request, you must specify the gateway and the disk information on which you are\n creating the volume. In response, the gateway creates the volume and returns volume\n information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target\n ARN that initiators can use to connect to the volume target.
", "smithy.api#examples": [ { "title": "To create a stored iSCSI volume", "documentation": "Creates a stored volume on a specified stored gateway.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0", "SnapshotId": "snap-f47b7b94", "PreserveExistingData": true, "TargetName": "my-volume", "NetworkInterfaceId": "10.1.1.1" }, "output": { "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", "VolumeSizeInBytes": 1099511627776, "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" } } ] } }, "com.amazonaws.storagegateway#CreateStorediSCSIVolumeInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "DiskId": { "target": "com.amazonaws.storagegateway#DiskId", "traits": { "smithy.api#documentation": "The unique identifier for the gateway local disk that is configured as a stored volume.\n Use ListLocalDisks to\n list disk IDs for a gateway.
", "smithy.api#required": {} } }, "SnapshotId": { "target": "com.amazonaws.storagegateway#SnapshotId", "traits": { "smithy.api#documentation": "The snapshot ID (e.g., \"snap-1122aabb\") of the snapshot to restore as the new stored\n volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;\n otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API\n Reference.
" } }, "PreserveExistingData": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Set to true if you want to preserve the data on the local disk. Otherwise,\n set to false to create an empty volume.
Valid Values: true | false\n
The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
", "smithy.api#required": {} } }, "NetworkInterfaceId": { "target": "com.amazonaws.storagegateway#NetworkInterfaceId", "traits": { "smithy.api#documentation": "The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4\n and IPv6 addresses. Use DescribeGatewayInformation to get a list of the\n network interfaces available on a gateway.
\nValid Values: A valid IP address.
", "smithy.api#required": {} } }, "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { "smithy.api#documentation": "Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value\n pair.
\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nA JSON object containing one or more of the following fields:
\nThe Amazon Resource Name (ARN) of the configured volume.
" } }, "VolumeSizeInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The size of the volume in bytes.
" } }, "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that\n initiators can use to connect to the target.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing the following fields:
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CreateTapePool": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#CreateTapePoolInput" }, "output": { "target": "com.amazonaws.storagegateway#CreateTapePoolOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Creates a new custom tape pool. You can use custom tape pool to enable tape retention\n lock on tapes that are archived in the custom pool.
" } }, "com.amazonaws.storagegateway#CreateTapePoolInput": { "type": "structure", "members": { "PoolName": { "target": "com.amazonaws.storagegateway#PoolName", "traits": { "smithy.api#documentation": "The name of the new custom tape pool.
", "smithy.api#required": {} } }, "StorageClass": { "target": "com.amazonaws.storagegateway#TapeStorageClass", "traits": { "smithy.api#documentation": "The storage class that is associated with the new custom pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
", "smithy.api#required": {} } }, "RetentionLockType": { "target": "com.amazonaws.storagegateway#RetentionLockType", "traits": { "smithy.api#documentation": "Tape retention lock can be configured in two modes. When configured in governance mode,\n Amazon Web Services accounts with specific IAM permissions are authorized to remove the\n tape retention lock from archived virtual tapes. When configured in compliance mode, the\n tape retention lock cannot be removed by any user, including the root Amazon Web Services account.
" } }, "RetentionLockTimeInDays": { "target": "com.amazonaws.storagegateway#RetentionLockTimeInDays", "traits": { "smithy.api#documentation": "Tape retention lock time is set in days. Tape retention lock can be enabled for up to\n 100 years (36,500 days).
" } }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { "smithy.api#documentation": "A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value\n pair.
\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nThe unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the\n ListTapePools operation to return a list of tape pools for your\n account and Amazon Web Services Region.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CreateTapeWithBarcode": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#CreateTapeWithBarcodeInput" }, "output": { "target": "com.amazonaws.storagegateway#CreateTapeWithBarcodeOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Creates a virtual tape by using your own barcode. You write data to the virtual tape and\n then archive the tape. A barcode is unique and cannot be reused if it has already been used\n on a tape. This applies to barcodes used on deleted tapes. This operation is only supported\n in the tape gateway type.
\nCache storage must be allocated to the gateway before you can create a virtual tape.\n Use the AddCache operation to add cache storage to a gateway.
\nThe unique Amazon Resource Name (ARN) that represents the gateway to associate the\n virtual tape with. Use the ListGateways operation to return a list of\n gateways for your account and Amazon Web Services Region.
", "smithy.api#required": {} } }, "TapeSizeInBytes": { "target": "com.amazonaws.storagegateway#TapeSize", "traits": { "smithy.api#documentation": "The size, in bytes, of the virtual tape that you want to create.
\nThe size must be aligned by gigabyte (1024*1024*1024 bytes).
\nThe barcode that you want to assign to the tape.
\nBarcodes cannot be reused. This includes barcodes used for tapes that have been\n deleted.
\nSet to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
" } }, "Worm": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Set to TRUE if the tape you are creating is to be configured as a\n write-once-read-many (WORM) tape.
A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each\n tag is a key-value pair.
\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nCreateTapeWithBarcodeInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#CreateTapeWithBarcodeOutput": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "A unique Amazon Resource Name (ARN) that represents the virtual tape that was\n created.
" } } }, "traits": { "smithy.api#documentation": "CreateTapeOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CreateTapes": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#CreateTapesInput" }, "output": { "target": "com.amazonaws.storagegateway#CreateTapesOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Creates one or more virtual tapes. You write data to the virtual tapes and then archive\n the tapes. This operation is only supported in the tape gateway type.
\nCache storage must be allocated to the gateway before you can create virtual tapes.\n Use the AddCache operation to add cache storage to a gateway.
\nThe unique Amazon Resource Name (ARN) that represents the gateway to associate the\n virtual tapes with. Use the ListGateways operation to return a list of\n gateways for your account and Amazon Web Services Region.
", "smithy.api#required": {} } }, "TapeSizeInBytes": { "target": "com.amazonaws.storagegateway#TapeSize", "traits": { "smithy.api#documentation": "The size, in bytes, of the virtual tapes that you want to create.
\nThe size must be aligned by gigabyte (1024*1024*1024 bytes).
\nA unique identifier that you use to retry a request. If you retry a request, use the\n same ClientToken you specified in the initial request.
Using the same ClientToken prevents creating the tape multiple\n times.
The number of virtual tapes that you want to create.
", "smithy.api#required": {} } }, "TapeBarcodePrefix": { "target": "com.amazonaws.storagegateway#TapeBarcodePrefix", "traits": { "smithy.api#documentation": "A prefix that you append to the barcode of the virtual tape you are creating. This\n prefix makes the barcode unique.
\nThe prefix must be 1-4 characters in length and must be one of the uppercase letters\n from A to Z.
\nSet to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
" } }, "Worm": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Set to TRUE if the tape you are creating is to be configured as a\n write-once-read-many (WORM) tape.
A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value\n pair.
\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nCreateTapesInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#CreateTapesOutput": { "type": "structure", "members": { "TapeARNs": { "target": "com.amazonaws.storagegateway#TapeARNs", "traits": { "smithy.api#documentation": "A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that\n were created.
" } } }, "traits": { "smithy.api#documentation": "CreateTapeOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#CreatedDate": { "type": "timestamp" }, "com.amazonaws.storagegateway#DNSHostName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$" } }, "com.amazonaws.storagegateway#DayOfMonth": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 28 } } }, "com.amazonaws.storagegateway#DayOfWeek": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 6 } } }, "com.amazonaws.storagegateway#DaysOfWeek": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#DayOfWeek" }, "traits": { "smithy.api#length": { "min": 1, "max": 7 } } }, "com.amazonaws.storagegateway#DeleteAutomaticTapeCreationPolicy": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DeleteAutomaticTapeCreationPolicyInput" }, "output": { "target": "com.amazonaws.storagegateway#DeleteAutomaticTapeCreationPolicyOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Deletes the automatic tape creation policy of a gateway. If you delete this policy, new\n virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway\n in your request to remove the policy.
" } }, "com.amazonaws.storagegateway#DeleteAutomaticTapeCreationPolicyInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DeleteAutomaticTapeCreationPolicyOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeleteBandwidthRateLimit": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DeleteBandwidthRateLimitInput" }, "output": { "target": "com.amazonaws.storagegateway#DeleteBandwidthRateLimitOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Deletes the bandwidth rate limits of a gateway. You can delete either the upload and\n download bandwidth rate limit, or you can delete both. If you delete only one of the\n limits, the other limit remains unchanged. To specify which gateway to work with, use the\n Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only\n for the stored volume, cached volume, and tape gateway types.
", "smithy.api#examples": [ { "title": "To delete bandwidth rate limits of gateway", "documentation": "Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "BandwidthType": "All" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" } } ] } }, "com.amazonaws.storagegateway#DeleteBandwidthRateLimitInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "BandwidthType": { "target": "com.amazonaws.storagegateway#BandwidthType", "traits": { "smithy.api#documentation": "One of the BandwidthType values that indicates the gateway bandwidth rate limit to\n delete.
\nValid Values: UPLOAD | DOWNLOAD | ALL\n
A JSON object containing the following fields:
\nA JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth\n rate information was deleted.
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeleteCacheReport": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DeleteCacheReportInput" }, "output": { "target": "com.amazonaws.storagegateway#DeleteCacheReportOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Deletes the specified cache report and any associated tags from the Storage Gateway database. You can only delete completed reports. If the status of the\n report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You\n can use CancelCacheReport to cancel an IN-PROGRESS report.
\n DeleteCacheReport does not delete the report object from your Amazon S3 bucket.
The Amazon Resource Name (ARN) of the cache report you want to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DeleteCacheReportOutput": { "type": "structure", "members": { "CacheReportARN": { "target": "com.amazonaws.storagegateway#CacheReportARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cache report you want to delete.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeleteChapCredentials": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DeleteChapCredentialsInput" }, "output": { "target": "com.amazonaws.storagegateway#DeleteChapCredentialsOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified\n iSCSI target and initiator pair. This operation is supported in volume and tape gateway\n types.
", "smithy.api#examples": [ { "title": "To delete CHAP credentials", "documentation": "Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.", "input": { "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume", "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com" }, "output": { "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume", "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com" } } ] } }, "com.amazonaws.storagegateway#DeleteChapCredentialsInput": { "type": "structure", "members": { "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for\n specified VolumeARN.
", "smithy.api#required": {} } }, "InitiatorName": { "target": "com.amazonaws.storagegateway#IqnName", "traits": { "smithy.api#documentation": "The iSCSI initiator that connects to the target.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing one or more of the following fields:
\nThe Amazon Resource Name (ARN) of the target.
" } }, "InitiatorName": { "target": "com.amazonaws.storagegateway#IqnName", "traits": { "smithy.api#documentation": "The iSCSI initiator that connects to the target.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing the following fields:
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeleteFileShare": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DeleteFileShareInput" }, "output": { "target": "com.amazonaws.storagegateway#DeleteFileShareOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Deletes a file share from an S3 File Gateway. This operation is only supported for S3\n File Gateways.
" } }, "com.amazonaws.storagegateway#DeleteFileShareInput": { "type": "structure", "members": { "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file share to be deleted.
", "smithy.api#required": {} } }, "ForceDelete": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "If this value is set to true, the operation deletes a file share\n immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share is\n not deleted until all data is uploaded to Amazon Web Services. This process aborts the data\n upload process, and the file share enters the FORCE_DELETING status.
Valid Values: true | false\n
DeleteFileShareInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DeleteFileShareOutput": { "type": "structure", "members": { "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted file share.
" } } }, "traits": { "smithy.api#documentation": "DeleteFileShareOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeleteGateway": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DeleteGatewayInput" }, "output": { "target": "com.amazonaws.storagegateway#DeleteGatewayOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name\n (ARN) of the gateway in your request. The operation deletes the gateway; however, it does\n not delete the gateway virtual machine (VM) from your host computer.
\nAfter you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway\n volumes are not deleted upon deleting the gateway, however, pending snapshots will not\n complete. After you delete a gateway, your next step is to remove it from your\n environment.
\nYou no longer pay software charges after the gateway is deleted; however, your\n existing Amazon EBS snapshots persist and you will continue to be billed for these\n snapshots.\u00a0You can choose to remove all remaining Amazon EBS snapshots by canceling your\n Amazon EC2 subscription.\u00a0 If you prefer not to cancel your Amazon EC2 subscription, you\n can delete your snapshots using the Amazon EC2 console. For more information, see the\n Storage Gateway detail\n page.
\nA JSON object containing the ID of the gateway to delete.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DeleteGatewayOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#documentation": "A JSON object containing the ID of the deleted gateway.
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeleteSnapshotSchedule": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DeleteSnapshotScheduleInput" }, "output": { "target": "com.amazonaws.storagegateway#DeleteSnapshotScheduleOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Deletes a snapshot of a volume.
\nYou can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API\n action enables you to delete a snapshot schedule for a volume. For more information, see\n Backing up your\n volumes. In the DeleteSnapshotSchedule request, you identify the\n volume by providing its Amazon Resource Name (ARN). This operation is only supported for\n cached volume gateway types.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n go to DescribeSnapshots\n in the Amazon Elastic Compute Cloud API Reference.
\nThe volume which snapshot schedule to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DeleteSnapshotScheduleOutput": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The volume which snapshot schedule was deleted.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeleteTape": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DeleteTapeInput" }, "output": { "target": "com.amazonaws.storagegateway#DeleteTapeOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Deletes the specified virtual tape. This operation is only supported in the tape gateway\n type.
", "smithy.api#examples": [ { "title": "To delete a virtual tape", "documentation": "This example deletes the specified virtual tape.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B", "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" }, "output": { "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" } } ] } }, "com.amazonaws.storagegateway#DeleteTapeArchive": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DeleteTapeArchiveInput" }, "output": { "target": "com.amazonaws.storagegateway#DeleteTapeArchiveOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is\n only supported in the tape gateway type.
", "smithy.api#examples": [ { "title": "To delete a virtual tape from the shelf (VTS)", "documentation": "Deletes the specified virtual tape from the virtual tape shelf (VTS).", "input": { "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" }, "output": { "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" } } ] } }, "com.amazonaws.storagegateway#DeleteTapeArchiveInput": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf\n (VTS).
", "smithy.api#required": {} } }, "BypassGovernanceRetention": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Set to TRUE to delete an archived tape that belongs to a custom pool with\n tape retention lock. Only archived tapes with tape retention lock set to\n governance can be deleted. Archived tapes with tape retention lock set to\n compliance can't be deleted.
DeleteTapeArchiveInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DeleteTapeArchiveOutput": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual\n tape shelf (VTS).
" } } }, "traits": { "smithy.api#documentation": "DeleteTapeArchiveOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeleteTapeInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is\n associated with. Use the ListGateways operation to return a list of\n gateways for your account and Amazon Web Services Region.
", "smithy.api#required": {} } }, "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape to delete.
", "smithy.api#required": {} } }, "BypassGovernanceRetention": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Set to TRUE to delete an archived tape that belongs to a custom pool with\n tape retention lock. Only archived tapes with tape retention lock set to\n governance can be deleted. Archived tapes with tape retention lock set to\n compliance can't be deleted.
DeleteTapeInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DeleteTapeOutput": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted virtual tape.
" } } }, "traits": { "smithy.api#documentation": "DeleteTapeOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeleteTapePool": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DeleteTapePoolInput" }, "output": { "target": "com.amazonaws.storagegateway#DeleteTapePoolOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes\n in the pool and if there are no automatic tape creation policies that reference the custom\n tape pool.
" } }, "com.amazonaws.storagegateway#DeleteTapePoolInput": { "type": "structure", "members": { "PoolARN": { "target": "com.amazonaws.storagegateway#PoolARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom tape pool to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DeleteTapePoolOutput": { "type": "structure", "members": { "PoolARN": { "target": "com.amazonaws.storagegateway#PoolARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom tape pool being deleted.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeleteVolume": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DeleteVolumeInput" }, "output": { "target": "com.amazonaws.storagegateway#DeleteVolumeOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.\n This operation is only supported in the cached volume and stored volume types. For stored\n volume gateways, the local disk that was configured as the storage volume is not deleted.\n You can reuse the local disk to create another storage volume.
\nBefore you delete a volume, make sure there are no iSCSI connections to the volume you\n are deleting. You should also make sure there is no snapshot in progress. You can use the\n Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are\n deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API\n Reference.
\nIn the request, you must provide the Amazon Resource Name (ARN) of the storage volume\n you want to delete.
", "smithy.api#examples": [ { "title": "To delete a gateway volume", "documentation": "Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.", "input": { "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" }, "output": { "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" } } ] } }, "com.amazonaws.storagegateway#DeleteVolumeInput": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume. Use the ListVolumes\n operation to return a list of gateway volumes.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing the DeleteVolumeInput$VolumeARN to\n delete.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DeleteVolumeOutput": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same\n ARN you provided in the request.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was\n deleted.
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeprecationDate": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.storagegateway#DescribeAvailabilityMonitorTest": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeAvailabilityMonitorTestInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeAvailabilityMonitorTestOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns information about the most recent high availability monitoring test that was\n performed on the host in a cluster. If a test isn't performed, the status and start\n time in the response would be null.
" } }, "com.amazonaws.storagegateway#DescribeAvailabilityMonitorTestInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeAvailabilityMonitorTestOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "Status": { "target": "com.amazonaws.storagegateway#AvailabilityMonitorTestStatus", "traits": { "smithy.api#documentation": "The status of the high availability monitoring test. If a test hasn't been\n performed, the value of this field is null.
" } }, "StartTime": { "target": "com.amazonaws.storagegateway#Time", "traits": { "smithy.api#documentation": "The time the high availability monitoring test was started. If a test hasn't been\n performed, the value of this field is null.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeBandwidthRateLimit": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeBandwidthRateLimitInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeBandwidthRateLimitOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns the bandwidth rate limits of a gateway. By default, these limits are not set,\n which means no bandwidth rate limiting is in effect. This operation is supported only for\n the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits\n for S3 file gateways, use DescribeBandwidthRateLimitSchedule.
\nThis operation returns a value for a bandwidth rate limit only if the limit is set. If\n no limits are set for the gateway, then this operation returns only the gateway ARN in the\n response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of\n the gateway in your request.
", "smithy.api#examples": [ { "title": "To describe the bandwidth rate limits of a gateway", "documentation": "Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "AverageUploadRateLimitInBitsPerSec": 102400, "AverageDownloadRateLimitInBitsPerSec": 204800 } } ] } }, "com.amazonaws.storagegateway#DescribeBandwidthRateLimitInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the gateway.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeBandwidthRateLimitOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "AverageUploadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthUploadRateLimit", "traits": { "smithy.api#documentation": "The average upload bandwidth rate limit in bits per second. This field does not appear\n in the response if the upload rate limit is not set.
" } }, "AverageDownloadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", "traits": { "smithy.api#documentation": "The average download bandwidth rate limit in bits per second. This field does not appear\n in the response if the download rate limit is not set.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing the following fields:
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeBandwidthRateLimitSchedule": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeBandwidthRateLimitScheduleInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeBandwidthRateLimitScheduleOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns information about the bandwidth rate limit schedule of a gateway. By default,\n gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting\n is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx\n file gateways do not support bandwidth rate limits.
\nThis operation returns information about a gateway's bandwidth rate limit schedule. A\n bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A\n bandwidth rate limit interval defines a period of time on one or more days of the week,\n during which bandwidth rate limits are specified for uploading, downloading, or both.
\nA bandwidth rate limit interval consists of one or more days of the week, a start hour\n and minute, an ending hour and minute, and bandwidth rate limits for uploading and\n downloading
\nIf no bandwidth rate limit schedule intervals are set for the gateway, this operation\n returns an empty response. To specify which gateway to describe, use the Amazon Resource\n Name (ARN) of the gateway in your request.
" } }, "com.amazonaws.storagegateway#DescribeBandwidthRateLimitScheduleInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeBandwidthRateLimitScheduleOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "BandwidthRateLimitIntervals": { "target": "com.amazonaws.storagegateway#BandwidthRateLimitIntervals", "traits": { "smithy.api#documentation": "An array that contains the bandwidth rate limit intervals for a tape or volume gateway.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeCache": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeCacheInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeCacheOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns information about the cache of a gateway. This operation is only supported in\n the cached volume, tape, and file gateway types.
\nThe response includes disk IDs that are configured as cache, and it includes the amount\n of cache allocated and used.
", "smithy.api#examples": [ { "title": "To describe cache information", "documentation": "Returns information about the cache of a gateway.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:04:00.0-scsi-0:1:0:0" ], "CacheAllocatedInBytes": 2199023255552, "CacheUsedPercentage": 0.07, "CacheDirtyPercentage": 0.07, "CacheHitPercentage": 99.68, "CacheMissPercentage": 0.32 } } ] } }, "com.amazonaws.storagegateway#DescribeCacheInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeCacheOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "DiskIds": { "target": "com.amazonaws.storagegateway#DiskIds", "traits": { "smithy.api#documentation": "An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.
" } }, "CacheAllocatedInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The amount of cache in bytes allocated to a gateway.
" } }, "CacheUsedPercentage": { "target": "com.amazonaws.storagegateway#double", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Percent use of the gateway's cache storage. This metric applies only to the\n gateway-cached volume setup. The sample is taken at the end of the reporting period.
" } }, "CacheDirtyPercentage": { "target": "com.amazonaws.storagegateway#double", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The file share's contribution to the overall percentage of the gateway's cache\n that has not been persisted to Amazon Web Services. The sample is taken at the end of the\n reporting period.
" } }, "CacheHitPercentage": { "target": "com.amazonaws.storagegateway#double", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Percent of application read operations from the file shares that are served from cache.\n The sample is taken at the end of the reporting period.
" } }, "CacheMissPercentage": { "target": "com.amazonaws.storagegateway#double", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Percent of application read operations from the file shares that are not served from\n cache. The sample is taken at the end of the reporting period.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeCacheReport": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeCacheReportInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeCacheReportOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns information about the specified cache report, including completion status and\n generation progress.
" } }, "com.amazonaws.storagegateway#DescribeCacheReportInput": { "type": "structure", "members": { "CacheReportARN": { "target": "com.amazonaws.storagegateway#CacheReportARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cache report you want to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeCacheReportOutput": { "type": "structure", "members": { "CacheReportInfo": { "target": "com.amazonaws.storagegateway#CacheReportInfo", "traits": { "smithy.api#documentation": "Contains all informational fields associated with a cache report. Includes name, ARN,\n tags, status, progress, filters, start time, and end time.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeCachediSCSIVolumes": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeCachediSCSIVolumesInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeCachediSCSIVolumesOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns a description of the gateway volumes specified in the request. This operation is\n only supported in the cached volume gateway types.
\nThe list of gateway volumes in the request must be from one gateway. In the response,\n Storage Gateway returns volume information sorted by volume Amazon Resource Name\n (ARN).
", "smithy.api#examples": [ { "title": "To describe gateway cached iSCSI volumes", "documentation": "Returns a description of the gateway cached iSCSI volumes specified in the request.", "input": { "VolumeARNs": [ "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" ] }, "output": { "CachediSCSIVolumes": [ { "VolumeiSCSIAttributes": { "ChapEnabled": true, "LunNumber": 1, "NetworkInterfaceId": "10.243.43.207", "NetworkInterfacePort": 3260, "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" }, "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", "VolumeId": "vol-1122AABB", "VolumeSizeInBytes": 1099511627776, "VolumeStatus": "AVAILABLE", "VolumeType": "CACHED iSCSI" } ] } } ] } }, "com.amazonaws.storagegateway#DescribeCachediSCSIVolumesInput": { "type": "structure", "members": { "VolumeARNs": { "target": "com.amazonaws.storagegateway#VolumeARNs", "traits": { "smithy.api#documentation": "An array of strings where each string represents the Amazon Resource Name (ARN) of a\n cached volume. All of the specified cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeCachediSCSIVolumesOutput": { "type": "structure", "members": { "CachediSCSIVolumes": { "target": "com.amazonaws.storagegateway#CachediSCSIVolumes", "traits": { "smithy.api#documentation": "An array of objects where each object contains metadata about one cached volume.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing the following fields:
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeChapCredentials": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeChapCredentialsInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeChapCredentialsOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials\n information for a specified iSCSI target, one for each target-initiator pair. This\n operation is supported in the volume and tape gateway types.
", "smithy.api#examples": [ { "title": "To describe CHAP credetnitals for an iSCSI", "documentation": "Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.", "input": { "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" }, "output": { "ChapCredentials": [ { "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume", "SecretToAuthenticateInitiator": "111111111111", "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", "SecretToAuthenticateTarget": "222222222222" } ] } } ] } }, "com.amazonaws.storagegateway#DescribeChapCredentialsInput": { "type": "structure", "members": { "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for\n specified VolumeARN.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume\n target.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeChapCredentialsOutput": { "type": "structure", "members": { "ChapCredentials": { "target": "com.amazonaws.storagegateway#ChapCredentials", "traits": { "smithy.api#documentation": "An array of ChapInfo objects that represent CHAP credentials. Each\n object in the array contains CHAP credential information for one target-initiator pair. If\n no CHAP credentials are set, an empty array is returned. CHAP credential information is\n provided in a JSON object with the following fields:
\n\n InitiatorName: The iSCSI initiator that connects to\n the target.
\n\n SecretToAuthenticateInitiator: The secret key that\n the initiator (for example, the Windows client) must provide to participate in mutual\n CHAP with the target.
\n\n SecretToAuthenticateTarget: The secret key that the\n target must provide to participate in mutual CHAP with the initiator (e.g. Windows\n client).
\n\n TargetARN: The Amazon Resource Name (ARN) of the\n storage volume.
\nA JSON object containing the following fields:
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeFileSystemAssociations": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeFileSystemAssociationsInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeFileSystemAssociationsOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Gets the file system association information. This operation is only supported for FSx\n File Gateways.
" } }, "com.amazonaws.storagegateway#DescribeFileSystemAssociationsInput": { "type": "structure", "members": { "FileSystemAssociationARNList": { "target": "com.amazonaws.storagegateway#FileSystemAssociationARNList", "traits": { "smithy.api#documentation": "An array containing the Amazon Resource Name (ARN) of each file system association to be\n described.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeFileSystemAssociationsOutput": { "type": "structure", "members": { "FileSystemAssociationInfoList": { "target": "com.amazonaws.storagegateway#FileSystemAssociationInfoList", "traits": { "smithy.api#documentation": "An array containing the FileSystemAssociationInfo data type of each file\n system association to be described.\n
Returns metadata about a gateway such as its name, network interfaces, time zone,\n status, and software version. To specify which gateway to describe, use the Amazon Resource\n Name (ARN) of the gateway in your request.
", "smithy.api#examples": [ { "title": "To describe metadata about the gateway", "documentation": "Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "GatewayId": "sgw-AABB1122", "GatewayName": "My_Gateway", "GatewayTimezone": "GMT-8:00", "GatewayState": "STATE_RUNNING", "GatewayNetworkInterfaces": [ { "Ipv4Address": "10.35.69.216" } ], "GatewayType": "STORED", "NextUpdateAvailabilityDate": "2017-01-02T16:00:00", "LastSoftwareUpdate": "2016-01-02T16:00:00" } } ] } }, "com.amazonaws.storagegateway#DescribeGatewayInformationInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing the ID of the gateway.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeGatewayInformationOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "GatewayId": { "target": "com.amazonaws.storagegateway#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.
" } }, "GatewayName": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "The name you configured for your gateway.
" } }, "GatewayTimezone": { "target": "com.amazonaws.storagegateway#GatewayTimezone", "traits": { "smithy.api#documentation": "A value that indicates the time zone configured for the gateway.
" } }, "GatewayState": { "target": "com.amazonaws.storagegateway#GatewayState", "traits": { "smithy.api#documentation": "A value that indicates the operating state of the gateway.
" } }, "GatewayNetworkInterfaces": { "target": "com.amazonaws.storagegateway#GatewayNetworkInterfaces", "traits": { "smithy.api#documentation": "A NetworkInterface array that contains descriptions of the gateway\n network interfaces.
" } }, "GatewayType": { "target": "com.amazonaws.storagegateway#GatewayType", "traits": { "smithy.api#documentation": "The type of the gateway.
\nAmazon FSx File Gateway is no longer available to new customers. Existing\n customers of FSx File Gateway can continue to use the service normally. For\n capabilities similar to FSx File Gateway, visit this blog post.
\nThe date on which an update to the gateway is available. This date is in the time zone\n of the gateway. If the gateway is not available for an update this field is not returned in\n the response.
" } }, "LastSoftwareUpdate": { "target": "com.amazonaws.storagegateway#LastSoftwareUpdate", "traits": { "smithy.api#documentation": "The date on which the last software update was applied to the gateway. If the gateway\n has never been updated, this field does not return a value in the response. This only only\n exist and returns once it have been chosen and set by the SGW service, based on the OS\n version of the gateway VM
" } }, "Ec2InstanceId": { "target": "com.amazonaws.storagegateway#Ec2InstanceId", "traits": { "smithy.api#documentation": "The ID of the Amazon EC2 instance that was used to launch the gateway.
" } }, "Ec2InstanceRegion": { "target": "com.amazonaws.storagegateway#Ec2InstanceRegion", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where the Amazon EC2 instance is located.
" } }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { "smithy.api#documentation": "A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each\n tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all\n tags using the ListTagsForResource API operation.
The configuration settings for the virtual private cloud (VPC) endpoint for your\n gateway.
" } }, "CloudWatchLogGroupARN": { "target": "com.amazonaws.storagegateway#CloudWatchLogGroupARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor events in the gateway. This field only only exist and returns once it have been\n chosen and set by the SGW service, based on the OS version of the gateway VM
" } }, "HostEnvironment": { "target": "com.amazonaws.storagegateway#HostEnvironment", "traits": { "smithy.api#documentation": "The type of hardware or software platform on which the gateway is running.
\nTape Gateway is no longer available on Snow Family devices.
\nThe type of endpoint for your gateway.
\nValid Values: STANDARD | FIPS\n
Date after which this gateway will not receive software updates for new features.
" } }, "DeprecationDate": { "target": "com.amazonaws.storagegateway#DeprecationDate", "traits": { "smithy.api#documentation": "Date after which this gateway will not receive software updates for new features and bug\n fixes.
" } }, "GatewayCapacity": { "target": "com.amazonaws.storagegateway#GatewayCapacity", "traits": { "smithy.api#documentation": "Specifies the size of the gateway's metadata cache.
" } }, "SupportedGatewayCapacities": { "target": "com.amazonaws.storagegateway#SupportedGatewayCapacities", "traits": { "smithy.api#documentation": "A list of the metadata cache sizes that the gateway can support based on its current\n hardware specifications.
" } }, "HostEnvironmentId": { "target": "com.amazonaws.storagegateway#HostEnvironmentId", "traits": { "smithy.api#documentation": "A unique identifier for the specific instance of the host platform running the gateway.\n This value is only available for certain host environments, and its format depends on the\n host environment type.
" } }, "SoftwareVersion": { "target": "com.amazonaws.storagegateway#SoftwareVersion", "traits": { "smithy.api#documentation": "The version number of the software running on the gateway appliance.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing the following fields:
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeMaintenanceStartTime": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeMaintenanceStartTimeInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeMaintenanceStartTimeOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns your gateway's maintenance window schedule information, with values for\n monthly or weekly cadence, specific day and time to begin maintenance, and which types of\n updates to apply. Time values returned are for the gateway's time zone.
", "smithy.api#examples": [ { "title": "To describe gateway's maintenance start time", "documentation": "Returns your gateway's weekly maintenance start time including the day and time of the week.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "HourOfDay": 15, "MinuteOfHour": 35, "DayOfWeek": 2, "Timezone": "GMT+7:00" } } ] } }, "com.amazonaws.storagegateway#DescribeMaintenanceStartTimeInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the gateway.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeMaintenanceStartTimeOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "HourOfDay": { "target": "com.amazonaws.storagegateway#HourOfDay", "traits": { "smithy.api#documentation": "The hour component of the maintenance start time represented as hh,\n where hh is the hour (0 to 23). The hour of the day is in the time\n zone of the gateway.
" } }, "MinuteOfHour": { "target": "com.amazonaws.storagegateway#MinuteOfHour", "traits": { "smithy.api#documentation": "The minute component of the maintenance start time represented as\n mm, where mm is the minute (0 to 59). The\n minute of the hour is in the time zone of the gateway.
" } }, "DayOfWeek": { "target": "com.amazonaws.storagegateway#DayOfWeek", "traits": { "smithy.api#documentation": "An ordinal number between 0 and 6 that represents the day of the week, where 0\n represents Sunday and 6 represents Saturday. The day of week is in the time zone of the\n gateway.
" } }, "DayOfMonth": { "target": "com.amazonaws.storagegateway#DayOfMonth", "traits": { "smithy.api#documentation": "The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month. It is not possible to\n set the maintenance schedule to start on days 29 through 31.
" } }, "Timezone": { "target": "com.amazonaws.storagegateway#GatewayTimezone", "traits": { "smithy.api#documentation": "A value that indicates the time zone that is set for the gateway. The start time and day\n of week specified should be in the time zone of the gateway.
" } }, "SoftwareUpdatePreferences": { "target": "com.amazonaws.storagegateway#SoftwareUpdatePreferences", "traits": { "smithy.api#documentation": "A set of variables indicating the software update preferences for the gateway.
\nIncludes AutomaticUpdatePolicy parameter with the following inputs:
\n ALL_VERSIONS - Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The\n gateway will still receive emergency version updates on rare occasions if necessary to\n remedy highly critical security or durability issues. You will be notified before an\n emergency version update is applied. These updates are applied during your gateway's\n scheduled maintenance window.
A JSON object containing the following fields:
\n\n DescribeMaintenanceStartTimeOutput$SoftwareUpdatePreferences\n
\nGets a description for one or more Network File System (NFS) file shares from an S3 File\n Gateway. This operation is only supported for S3 File Gateways.
" } }, "com.amazonaws.storagegateway#DescribeNFSFileSharesInput": { "type": "structure", "members": { "FileShareARNList": { "target": "com.amazonaws.storagegateway#FileShareARNList", "traits": { "smithy.api#documentation": "An array containing the Amazon Resource Name (ARN) of each file share to be\n described.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "DescribeNFSFileSharesInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeNFSFileSharesOutput": { "type": "structure", "members": { "NFSFileShareInfoList": { "target": "com.amazonaws.storagegateway#NFSFileShareInfoList", "traits": { "smithy.api#documentation": "An array containing a description for each requested file share.
" } } }, "traits": { "smithy.api#documentation": "DescribeNFSFileSharesOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeSMBFileShares": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeSMBFileSharesInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeSMBFileSharesOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Gets a description for one or more Server Message Block (SMB) file shares from a S3 File\n Gateway. This operation is only supported for S3 File Gateways.
" } }, "com.amazonaws.storagegateway#DescribeSMBFileSharesInput": { "type": "structure", "members": { "FileShareARNList": { "target": "com.amazonaws.storagegateway#FileShareARNList", "traits": { "smithy.api#documentation": "An array containing the Amazon Resource Name (ARN) of each file share to be\n described.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "DescribeSMBFileSharesInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeSMBFileSharesOutput": { "type": "structure", "members": { "SMBFileShareInfoList": { "target": "com.amazonaws.storagegateway#SMBFileShareInfoList", "traits": { "smithy.api#documentation": "An array containing a description for each requested file share.
" } } }, "traits": { "smithy.api#documentation": "DescribeSMBFileSharesOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeSMBSettings": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeSMBSettingsInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeSMBSettingsOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Gets a description of a Server Message Block (SMB) file share settings from a file\n gateway. This operation is only supported for file gateways.
" } }, "com.amazonaws.storagegateway#DescribeSMBSettingsInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeSMBSettingsOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "DomainName": { "target": "com.amazonaws.storagegateway#DomainName", "traits": { "smithy.api#documentation": "The name of the domain that the gateway is joined to.
" } }, "ActiveDirectoryStatus": { "target": "com.amazonaws.storagegateway#ActiveDirectoryStatus", "traits": { "smithy.api#documentation": "Indicates the status of a gateway that is a member of the Active Directory\n domain.
\nThis field is only used as part of a JoinDomain request. It is not\n affected by Active Directory connectivity changes that occur after the\n JoinDomain request succeeds.
\n ACCESS_DENIED: Indicates that the JoinDomain operation\n failed due to an authentication error.
\n DETACHED: Indicates that gateway is not joined to a domain.
\n JOINED: Indicates that the gateway has successfully joined a\n domain.
\n JOINING: Indicates that a JoinDomain operation is in\n progress.
\n NETWORK_ERROR: Indicates that JoinDomain operation\n failed due to a network or connectivity error.
\n TIMEOUT: Indicates that the JoinDomain operation failed\n because the operation didn't complete within the allotted time.
\n UNKNOWN_ERROR: Indicates that the JoinDomain operation\n failed due to another type of error.
This value is true if a password for the guest user smbguest\n is set, otherwise false. Only supported for S3 File Gateways.
Valid Values: true | false\n
The type of security strategy that was specified for file gateway.
\n\n ClientSpecified: If you choose this option, requests are established\n based on what is negotiated by the client. This option is recommended when you want\n to maximize compatibility across different clients in your environment. Supported\n only for S3 File Gateway.
\n MandatorySigning: If you choose this option, File Gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing turned on. This option\n works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later.\n
\n MandatoryEncryption: If you choose this option, File Gateway only\n allows connections from SMBv3 clients that have encryption turned on. Both 256-bit\n and 128-bit algorithms are allowed. This option is recommended for environments that\n handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows\n Server 2012, or later.
\n MandatoryEncryptionNoAes128: If you choose this option, File Gateway\n only allows connections from SMBv3 clients that use 256-bit AES encryption\n algorithms. 128-bit algorithms are not allowed. This option is recommended for\n environments that handle sensitive data. It works with SMB clients on Microsoft\n Windows 8, Windows Server 2012, or later.
The shares on this gateway appear when listing shares. Only supported for S3 File\n Gateways.
" } }, "SMBLocalGroups": { "target": "com.amazonaws.storagegateway#SMBLocalGroups", "traits": { "smithy.api#documentation": "A list of Active Directory users and groups that have special permissions for SMB file\n shares on the gateway.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeSnapshotSchedule": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeSnapshotScheduleInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeSnapshotScheduleOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Describes the snapshot schedule for the specified gateway volume. The snapshot schedule\n information includes intervals at which snapshots are automatically initiated on the\n volume. This operation is only supported in the cached volume and stored volume\n types.
", "smithy.api#examples": [ { "title": "To describe snapshot schedule for gateway volume", "documentation": "Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.", "input": { "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" }, "output": { "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", "StartAt": 6, "RecurrenceInHours": 24, "Description": "sgw-AABB1122:vol-AABB1122:Schedule", "Timezone": "GMT+7:00" } } ] } }, "com.amazonaws.storagegateway#DescribeSnapshotScheduleInput": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume. Use the ListVolumes\n operation to return a list of gateway volumes.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN\n of the volume.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeSnapshotScheduleOutput": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume that was specified in the request.
" } }, "StartAt": { "target": "com.amazonaws.storagegateway#HourOfDay", "traits": { "smithy.api#documentation": "The hour of the day at which the snapshot schedule begins represented as\n hh, where hh is the hour (0 to 23). The hour\n of the day is in the time zone of the gateway.
" } }, "RecurrenceInHours": { "target": "com.amazonaws.storagegateway#RecurrenceInHours", "traits": { "smithy.api#documentation": "The number of hours between snapshots.
" } }, "Description": { "target": "com.amazonaws.storagegateway#Description", "traits": { "smithy.api#documentation": "The snapshot description.
" } }, "Timezone": { "target": "com.amazonaws.storagegateway#GatewayTimezone", "traits": { "smithy.api#documentation": "A value that indicates the time zone of the gateway.
" } }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { "smithy.api#documentation": "A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource API operation.
Returns the description of the gateway volumes specified in the request. The list of\n gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only\n supported in stored volume gateway type.
", "smithy.api#examples": [ { "title": "To describe the volumes of a gateway", "documentation": "Returns the description of the gateway volumes specified in the request belonging to the same gateway.", "input": { "VolumeARNs": [ "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" ] }, "output": { "StorediSCSIVolumes": [ { "VolumeiSCSIAttributes": { "ChapEnabled": true, "NetworkInterfaceId": "10.243.43.207", "NetworkInterfacePort": 3260, "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" }, "PreservedExistingData": false, "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", "VolumeDiskId": "pci-0000:03:00.0-scsi-0:0:0:0", "VolumeId": "vol-1122AABB", "VolumeProgress": 23.7, "VolumeSizeInBytes": 1099511627776, "VolumeStatus": "BOOTSTRAPPING" } ] } } ] } }, "com.amazonaws.storagegateway#DescribeStorediSCSIVolumesInput": { "type": "structure", "members": { "VolumeARNs": { "target": "com.amazonaws.storagegateway#VolumeARNs", "traits": { "smithy.api#documentation": "An array of strings where each string represents the Amazon Resource Name (ARN) of a\n stored volume. All of the specified stored volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeStorediSCSIVolumesOutput": { "type": "structure", "members": { "StorediSCSIVolumes": { "target": "com.amazonaws.storagegateway#StorediSCSIVolumes", "traits": { "smithy.api#documentation": "Describes a single unit of output from DescribeStorediSCSIVolumes. The\n following fields are returned:
\n\n ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI\n target.
\n LunNumber: The logical disk number.
\n NetworkInterfaceId: The network interface ID of the stored volume that\n initiator use to map the stored volume as an iSCSI target.
\n NetworkInterfacePort: The port used to communicate with iSCSI\n targets.
\n PreservedExistingData: Indicates when the stored volume was created,\n existing data on the underlying local disk was preserved.
\n SourceSnapshotId: If the stored volume was created from a snapshot, this\n field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this\n field is not included.
\n StorediSCSIVolumes: An array of StorediSCSIVolume objects where each\n object contains metadata about one stored volume.
\n TargetARN: The Amazon Resource Name (ARN) of the volume target.
\n VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
\n VolumeDiskId: The disk ID of the local disk that was specified in the\n CreateStorediSCSIVolume operation.
\n VolumeId: The unique identifier of the storage volume, e.g.\n vol-1122AABB.
\n VolumeiSCSIAttributes: An VolumeiSCSIAttributes object\n that represents a collection of iSCSI attributes for one stored volume.
\n VolumeProgress: Represents the percentage complete if the volume is\n restoring or bootstrapping that represents the percent of data transferred. This\n field does not appear in the response if the stored volume is not restoring or\n bootstrapping.
\n VolumeSizeInBytes: The size of the volume in bytes.
\n VolumeStatus: One of the VolumeStatus values that indicates\n the state of the volume.
\n VolumeType: One of the enumeration values describing the type of the\n volume. Currently, only STORED volumes are supported.
Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This\n operation is only supported in the tape gateway type.
\nIf a specific TapeARN is not specified, Storage Gateway returns a\n description of all virtual tapes found in the VTS associated with your account.
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual\n tapes you want to describe.
" } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which to begin describing virtual\n tapes.
" } }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { "smithy.api#documentation": "Specifies that the number of virtual tapes described be limited to the specified\n number.
" } } }, "traits": { "smithy.api#documentation": "DescribeTapeArchivesInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeTapeArchivesOutput": { "type": "structure", "members": { "TapeArchives": { "target": "com.amazonaws.storagegateway#TapeArchives", "traits": { "smithy.api#documentation": "An array of virtual tape objects in the virtual tape shelf (VTS). The description\n includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned\n includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the\n tapes, progress of the description, and tape barcode.
" } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which the virtual tapes that were\n fetched for description ended. Use this marker in your next request to fetch the next set\n of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to\n describe, this field does not appear in the response.
" } } }, "traits": { "smithy.api#documentation": "DescribeTapeArchivesOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeTapeRecoveryPoints": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeTapeRecoveryPointsInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeTapeRecoveryPointsOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns a list of virtual tape recovery points that are available for the specified tape\n gateway.
\nA recovery point is a point-in-time view of a virtual tape at which all the data on the\n virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery\n points can be recovered to a new gateway. This operation is only supported in the tape\n gateway type.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "TapeRecoveryPointInfos", "pageSize": "Limit" } } }, "com.amazonaws.storagegateway#DescribeTapeRecoveryPointsInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which to begin describing the virtual\n tape recovery points.
" } }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { "smithy.api#documentation": "Specifies that the number of virtual tape recovery points that are described be limited\n to the specified number.
" } } }, "traits": { "smithy.api#documentation": "DescribeTapeRecoveryPointsInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeTapeRecoveryPointsOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "TapeRecoveryPointInfos": { "target": "com.amazonaws.storagegateway#TapeRecoveryPointInfos", "traits": { "smithy.api#documentation": "An array of TapeRecoveryPointInfos that are available for the specified gateway.
" } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which the virtual tape recovery points\n that were listed for description ended.
\nUse this marker in your next request to list the next set of virtual tape recovery\n points in the list. If there are no more recovery points to describe, this field does not\n appear in the response.
" } } }, "traits": { "smithy.api#documentation": "DescribeTapeRecoveryPointsOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeTapes": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeTapesInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeTapesOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns a description of virtual tapes that correspond to the specified Amazon Resource\n Names (ARNs). If TapeARN is not specified, returns a description of the\n virtual tapes associated with the specified gateway. This operation is only supported for\n the tape gateway type.
The operation supports pagination. By default, the operation returns a maximum of up to\n 100 tapes. You can optionally specify the Limit field in the body to limit the\n number of tapes in the response. If the number of tapes returned in the response is\n truncated, the response includes a Marker field. You can use this\n Marker value in your subsequent request to retrieve the next set of\n tapes.
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual\n tapes you want to describe. If this parameter is not specified, Tape gateway returns a\n description of all virtual tapes associated with the specified gateway.
" } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "A marker value, obtained in a previous call to DescribeTapes. This marker\n indicates which page of results to retrieve.
If not specified, the first page of results is retrieved.
" } }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { "smithy.api#documentation": "Specifies that the number of virtual tapes described be limited to the specified\n number.
\nAmazon Web Services may impose its own limit, if this field is not set.
\nDescribeTapesInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeTapesOutput": { "type": "structure", "members": { "Tapes": { "target": "com.amazonaws.storagegateway#Tapes", "traits": { "smithy.api#documentation": "An array of virtual tape descriptions.
" } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that can be used as part of a subsequent DescribeTapes\n call to retrieve the next page of results.
If a response does not contain a marker, then there are no more results to be\n retrieved.
" } } }, "traits": { "smithy.api#documentation": "DescribeTapesOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeUploadBuffer": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeUploadBufferInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeUploadBufferOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns information about the upload buffer of a gateway. This operation is supported\n for the stored volume, cached volume, and tape gateway types.
\nThe response includes disk IDs that are configured as upload buffer space, and it\n includes the amount of upload buffer space allocated and used.
", "smithy.api#examples": [ { "title": "To describe upload buffer of a gateway", "documentation": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:04:00.0-scsi-0:1:0:0" ], "UploadBufferUsedInBytes": 0, "UploadBufferAllocatedInBytes": 161061273600 } }, { "title": "To describe upload buffer of gateway", "documentation": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:04:00.0-scsi-0:1:0:0" ], "UploadBufferUsedInBytes": 161061273600, "UploadBufferAllocatedInBytes": 0 } } ] } }, "com.amazonaws.storagegateway#DescribeUploadBufferInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeUploadBufferOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "DiskIds": { "target": "com.amazonaws.storagegateway#DiskIds", "traits": { "smithy.api#documentation": "An array of the gateway's local disk IDs that are configured as working storage.\n Each local disk ID is specified as a string (minimum length of 1 and maximum length of\n 300). If no local disks are configured as working storage, then the DiskIds array is\n empty.
" } }, "UploadBufferUsedInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The total number of bytes being used in the gateway's upload buffer.
" } }, "UploadBufferAllocatedInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The total number of bytes allocated in the gateway's as upload buffer.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeVTLDevices": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeVTLDevicesInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeVTLDevicesOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns a description of virtual tape library (VTL) devices for the specified tape\n gateway. In the response, Storage Gateway returns VTL device information.
\nThis operation is only supported in the tape gateway type.
", "smithy.api#examples": [ { "title": "To describe virtual tape library (VTL) devices of a single gateway", "documentation": "Returns a description of virtual tape library (VTL) devices for the specified gateway.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", "VTLDeviceARNs": [], "Marker": "1", "Limit": 123 }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", "VTLDevices": [ { "DeviceiSCSIAttributes": { "ChapEnabled": false, "NetworkInterfaceId": "10.243.43.207", "NetworkInterfacePort": 3260, "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger" }, "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001", "VTLDeviceProductIdentifier": "L700", "VTLDeviceType": "Medium Changer", "VTLDeviceVendor": "STK" }, { "DeviceiSCSIAttributes": { "ChapEnabled": false, "NetworkInterfaceId": "10.243.43.209", "NetworkInterfacePort": 3260, "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01" }, "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001", "VTLDeviceProductIdentifier": "ULT3580-TD5", "VTLDeviceType": "Tape Drive", "VTLDeviceVendor": "IBM" }, { "DeviceiSCSIAttributes": { "ChapEnabled": false, "NetworkInterfaceId": "10.243.43.209", "NetworkInterfacePort": 3260, "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02" }, "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002", "VTLDeviceProductIdentifier": "ULT3580-TD5", "VTLDeviceType": "Tape Drive", "VTLDeviceVendor": "IBM" } ], "Marker": "1" } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "VTLDevices", "pageSize": "Limit" } } }, "com.amazonaws.storagegateway#DescribeVTLDevicesInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "VTLDeviceARNs": { "target": "com.amazonaws.storagegateway#VTLDeviceARNs", "traits": { "smithy.api#documentation": "An array of strings, where each string represents the Amazon Resource Name (ARN) of a\n VTL device.
\nAll of the specified VTL devices must be from the same gateway. If no VTL devices are\n specified, the result will contain all devices on the specified gateway.
\nAn opaque string that indicates the position at which to begin describing the VTL\n devices.
" } }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { "smithy.api#documentation": "Specifies that the number of VTL devices described be limited to the specified\n number.
" } } }, "traits": { "smithy.api#documentation": "DescribeVTLDevicesInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeVTLDevicesOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "VTLDevices": { "target": "com.amazonaws.storagegateway#VTLDevices", "traits": { "smithy.api#documentation": "An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL\n devices.
" } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which the VTL devices that were fetched\n for description ended. Use the marker in your next request to fetch the next set of VTL\n devices in the list. If there are no more VTL devices to describe, this field does not\n appear in the response.
" } } }, "traits": { "smithy.api#documentation": "DescribeVTLDevicesOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DescribeWorkingStorage": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DescribeWorkingStorageInput" }, "output": { "target": "com.amazonaws.storagegateway#DescribeWorkingStorageOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns information about the working storage of a gateway. This operation is only\n supported in the stored volumes gateway type. This operation is deprecated in cached\n volumes API version (20120630). Use DescribeUploadBuffer instead.
\nWorking storage is also referred to as upload buffer. You can also use the\n DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.
\nThe response includes disk IDs that are configured as working storage, and it includes\n the amount of working storage allocated and used.
", "smithy.api#examples": [ { "title": "To describe the working storage of a gateway [Depreciated]", "documentation": "This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "DiskIds": [ "pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:03:00.0-scsi-0:0:1:0" ], "WorkingStorageUsedInBytes": 789207040, "WorkingStorageAllocatedInBytes": 2199023255552 } } ] } }, "com.amazonaws.storagegateway#DescribeWorkingStorageInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the gateway.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DescribeWorkingStorageOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "DiskIds": { "target": "com.amazonaws.storagegateway#DiskIds", "traits": { "smithy.api#documentation": "An array of the gateway's local disk IDs that are configured as working storage.\n Each local disk ID is specified as a string (minimum length of 1 and maximum length of\n 300). If no local disks are configured as working storage, then the DiskIds array is\n empty.
" } }, "WorkingStorageUsedInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The total working storage in bytes in use by the gateway. If no working storage is\n configured for the gateway, this field returns 0.
" } }, "WorkingStorageAllocatedInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The total working storage in bytes allocated for the gateway. If no working storage is\n configured for the gateway, this field returns 0.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing the following fields:
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#Description": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.storagegateway#DetachVolume": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DetachVolumeInput" }, "output": { "target": "com.amazonaws.storagegateway#DetachVolumeOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Disconnects a volume from an iSCSI connection and then detaches the volume from the\n specified gateway. Detaching and attaching a volume enables you to recover your data from\n one gateway to a different gateway without creating a snapshot. It also makes it easier to\n move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2\n instance. This operation is only supported in the volume gateway type.
" } }, "com.amazonaws.storagegateway#DetachVolumeInput": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume to detach from the gateway.
", "smithy.api#required": {} } }, "ForceDetach": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { "smithy.api#documentation": "Set to true to forcibly remove the iSCSI connection of the target volume\n and detach the volume. The default is false. If this value is set to\n false, you must manually disconnect the iSCSI connection from the target\n volume.
Valid Values: true | false\n
AttachVolumeInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DetachVolumeOutput": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume that was detached.
" } } }, "traits": { "smithy.api#documentation": "AttachVolumeOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DeviceType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 50 } } }, "com.amazonaws.storagegateway#DeviceiSCSIAttributes": { "type": "structure", "members": { "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified\n name(iqn) of a tape drive or media changer target.
" } }, "NetworkInterfaceId": { "target": "com.amazonaws.storagegateway#NetworkInterfaceId", "traits": { "smithy.api#documentation": "The network interface identifier of the VTL device.
" } }, "NetworkInterfacePort": { "target": "com.amazonaws.storagegateway#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The port used to communicate with iSCSI VTL device targets.
" } }, "ChapEnabled": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Indicates whether mutual CHAP is enabled for the iSCSI target.
" } } }, "traits": { "smithy.api#documentation": "Lists iSCSI information about a VTL device.
" } }, "com.amazonaws.storagegateway#DisableGateway": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DisableGatewayInput" }, "output": { "target": "com.amazonaws.storagegateway#DisableGatewayOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Disables a tape gateway when the gateway is no longer functioning. For example, if your\n gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.
\nUse this operation for a tape gateway that is not reachable or not functioning. This\n operation is only supported in the tape gateway type.
\nAfter a gateway is disabled, it cannot be enabled.
\nDisableGatewayInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#DisableGatewayOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the disabled gateway.
" } } }, "traits": { "smithy.api#documentation": "DisableGatewayOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#DisassociateFileSystem": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#DisassociateFileSystemInput" }, "output": { "target": "com.amazonaws.storagegateway#DisassociateFileSystemOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Disassociates an Amazon FSx file system from the specified gateway. After the\n disassociation process finishes, the gateway can no longer access the Amazon FSx\n file system. This operation is only supported in the FSx File Gateway type.
" } }, "com.amazonaws.storagegateway#DisassociateFileSystemInput": { "type": "structure", "members": { "FileSystemAssociationARN": { "target": "com.amazonaws.storagegateway#FileSystemAssociationARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file system association to be deleted.
", "smithy.api#required": {} } }, "ForceDelete": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "If this value is set to true, the operation disassociates an Amazon FSx file\n system immediately. It ends all data uploads to the file system, and the file system\n association enters the FORCE_DELETING status. If this value is set to false,\n the Amazon FSx file system does not disassociate until all data is uploaded.
The Amazon Resource Name (ARN) of the deleted file system association.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#Disk": { "type": "structure", "members": { "DiskId": { "target": "com.amazonaws.storagegateway#DiskId", "traits": { "smithy.api#documentation": "The unique device ID or other distinguishing data that identifies a local disk.
" } }, "DiskPath": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "The path of a local disk in the gateway virtual machine (VM).
" } }, "DiskNode": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "The device node of a local disk as assigned by the virtualization environment.
" } }, "DiskStatus": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "A value that represents the status of a local disk.
" } }, "DiskSizeInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The local disk size in bytes.
" } }, "DiskAllocationType": { "target": "com.amazonaws.storagegateway#DiskAllocationType" }, "DiskAllocationResource": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in\n the response if the local disk is not defined as an iSCSI target. The format of this field\n is targetIqn::LUNNumber::region-volumeId.
" } }, "DiskAttributeList": { "target": "com.amazonaws.storagegateway#DiskAttributeList" } }, "traits": { "smithy.api#documentation": "Represents a gateway's local disk.
" } }, "com.amazonaws.storagegateway#DiskAllocationType": { "type": "string", "traits": { "smithy.api#documentation": "One of the DiskAllocationType enumeration values that identifies how a\n local disk is used.
Valid Values: UPLOAD_BUFFER | CACHE_STORAGE\n
A list of values that represents attributes of a local disk.
", "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.storagegateway#DiskId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 300 } } }, "com.amazonaws.storagegateway#DiskIds": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#DiskId" } }, "com.amazonaws.storagegateway#Disks": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#Disk" } }, "com.amazonaws.storagegateway#DomainName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+$" } }, "com.amazonaws.storagegateway#DomainUserName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^\\w[\\w\\.\\- ]*$" } }, "com.amazonaws.storagegateway#DomainUserPassword": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[ -~]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.storagegateway#DoubleObject": { "type": "double" }, "com.amazonaws.storagegateway#Ec2InstanceId": { "type": "string" }, "com.amazonaws.storagegateway#Ec2InstanceRegion": { "type": "string" }, "com.amazonaws.storagegateway#EncryptionType": { "type": "enum", "members": { "SseS3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SseS3" } }, "SseKms": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SseKms" } }, "DsseKms": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DsseKms" } } } }, "com.amazonaws.storagegateway#EndpointNetworkConfiguration": { "type": "structure", "members": { "IpAddresses": { "target": "com.amazonaws.storagegateway#IpAddressList", "traits": { "smithy.api#documentation": "A list of gateway IP addresses on which the associated Amazon FSx file system is\n available.
\nIf multiple file systems are associated with this gateway, this field is\n required.
\nSpecifies network configuration information for the gateway associated with the Amazon FSx file system.
" } }, "com.amazonaws.storagegateway#EndpointType": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 8 } } }, "com.amazonaws.storagegateway#ErrorCode": { "type": "enum", "members": { "ActivationKeyExpired": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ActivationKeyExpired" } }, "ActivationKeyInvalid": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ActivationKeyInvalid" } }, "ActivationKeyNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ActivationKeyNotFound" } }, "GatewayInternalError": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GatewayInternalError" } }, "GatewayNotConnected": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GatewayNotConnected" } }, "GatewayNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GatewayNotFound" } }, "GatewayProxyNetworkConnectionBusy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GatewayProxyNetworkConnectionBusy" } }, "AuthenticationFailure": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AuthenticationFailure" } }, "BandwidthThrottleScheduleNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BandwidthThrottleScheduleNotFound" } }, "Blocked": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Blocked" } }, "CannotExportSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CannotExportSnapshot" } }, "ChapCredentialNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ChapCredentialNotFound" } }, "DiskAlreadyAllocated": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DiskAlreadyAllocated" } }, "DiskDoesNotExist": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DiskDoesNotExist" } }, "DiskSizeGreaterThanVolumeMaxSize": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DiskSizeGreaterThanVolumeMaxSize" } }, "DiskSizeLessThanVolumeSize": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DiskSizeLessThanVolumeSize" } }, "DiskSizeNotGigAligned": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DiskSizeNotGigAligned" } }, "DuplicateCertificateInfo": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DuplicateCertificateInfo" } }, "DuplicateSchedule": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DuplicateSchedule" } }, "EndpointNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EndpointNotFound" } }, "IAMNotSupported": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IAMNotSupported" } }, "InitiatorInvalid": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InitiatorInvalid" } }, "InitiatorNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InitiatorNotFound" } }, "InternalError": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InternalError" } }, "InvalidGateway": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvalidGateway" } }, "InvalidEndpoint": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvalidEndpoint" } }, "InvalidParameters": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvalidParameters" } }, "InvalidSchedule": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvalidSchedule" } }, "LocalStorageLimitExceeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LocalStorageLimitExceeded" } }, "LunAlreadyAllocated_": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LunAlreadyAllocated " } }, "LunInvalid": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LunInvalid" } }, "JoinDomainInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JoinDomainInProgress" } }, "MaximumContentLengthExceeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MaximumContentLengthExceeded" } }, "MaximumTapeCartridgeCountExceeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MaximumTapeCartridgeCountExceeded" } }, "MaximumVolumeCountExceeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MaximumVolumeCountExceeded" } }, "NetworkConfigurationChanged": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkConfigurationChanged" } }, "NoDisksAvailable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NoDisksAvailable" } }, "NotImplemented": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotImplemented" } }, "NotSupported": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotSupported" } }, "OperationAborted": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OperationAborted" } }, "OutdatedGateway": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OutdatedGateway" } }, "ParametersNotImplemented": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ParametersNotImplemented" } }, "RegionInvalid": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RegionInvalid" } }, "RequestTimeout": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RequestTimeout" } }, "ServiceUnavailable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ServiceUnavailable" } }, "SnapshotDeleted": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SnapshotDeleted" } }, "SnapshotIdInvalid": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SnapshotIdInvalid" } }, "SnapshotInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SnapshotInProgress" } }, "SnapshotNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SnapshotNotFound" } }, "SnapshotScheduleNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SnapshotScheduleNotFound" } }, "StagingAreaFull": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StagingAreaFull" } }, "StorageFailure": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StorageFailure" } }, "TapeCartridgeNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TapeCartridgeNotFound" } }, "TargetAlreadyExists": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TargetAlreadyExists" } }, "TargetInvalid": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TargetInvalid" } }, "TargetNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TargetNotFound" } }, "UnauthorizedOperation": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UnauthorizedOperation" } }, "VolumeAlreadyExists": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VolumeAlreadyExists" } }, "VolumeIdInvalid": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VolumeIdInvalid" } }, "VolumeInUse": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VolumeInUse" } }, "VolumeNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VolumeNotFound" } }, "VolumeNotReady": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VolumeNotReady" } } } }, "com.amazonaws.storagegateway#EvictFilesFailingUpload": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#EvictFilesFailingUploadInput" }, "output": { "target": "com.amazonaws.storagegateway#EvictFilesFailingUploadOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Starts a process that cleans the specified file share's cache of file entries that are\n failing upload to Amazon S3. This API operation reports success if the request is\n received with valid arguments, and there are no other cache clean operations currently\n in-progress for the specified file share. After a successful request, the cache clean\n operation occurs asynchronously and reports progress using CloudWatch logs and\n notifications.
\nIf ForceRemove is set to True, the cache clean operation\n will delete file data from the gateway which might otherwise be recoverable. We\n recommend using this operation only after all other methods to clear files failing\n upload have been exhausted, and if your business need outweighs the potential data\n loss.
The Amazon Resource Name (ARN) of the file share for which you want to start the cache\n clean operation.
", "smithy.api#required": {} } }, "ForceRemove": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether cache entries with full or partial file data currently stored on the\n gateway will be forcibly removed by the cache clean operation.
\nValid arguments:
\n\n False - The cache clean operation skips cache entries failing upload\n if they are associated with data currently stored on the gateway. This preserves the\n cached data.
\n True - The cache clean operation removes cache entries failing upload\n even if they are associated with data currently stored on the gateway. This deletes\n the cached data.
If ForceRemove is set to True, the cache clean\n operation will delete file data from the gateway which might otherwise be\n recoverable.
The randomly generated ID of the CloudWatch notification associated with the\n cache clean operation. This ID is in UUID format.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#FileShareARN": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file share.
", "smithy.api#length": { "min": 50, "max": 500 } } }, "com.amazonaws.storagegateway#FileShareARNList": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#FileShareARN" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.storagegateway#FileShareClientList": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#Ipv4OrIpv6AddressCIDR" }, "traits": { "smithy.api#documentation": "The list of clients that are allowed to access the S3 File Gateway. The list must\n contain either valid IPv4/IPv6 addresses or valid CIDR blocks.
", "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.storagegateway#FileShareId": { "type": "string", "traits": { "smithy.api#documentation": "The ID of the file share.
", "smithy.api#length": { "min": 12, "max": 30 } } }, "com.amazonaws.storagegateway#FileShareInfo": { "type": "structure", "members": { "FileShareType": { "target": "com.amazonaws.storagegateway#FileShareType" }, "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN" }, "FileShareId": { "target": "com.amazonaws.storagegateway#FileShareId" }, "FileShareStatus": { "target": "com.amazonaws.storagegateway#FileShareStatus" }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#documentation": "Describes a file share. Only supported S3 File Gateway.
" } }, "com.amazonaws.storagegateway#FileShareInfoList": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#FileShareInfo" } }, "com.amazonaws.storagegateway#FileShareName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.storagegateway#FileShareStatus": { "type": "string", "traits": { "smithy.api#documentation": "The status of the file share.
\nValid Values: CREATING | UPDATING | AVAILABLE |\n DELETING\n
The type of the file share.
" } }, "com.amazonaws.storagegateway#FileSystemAssociationARN": { "type": "string", "traits": { "smithy.api#length": { "min": 50, "max": 500 } } }, "com.amazonaws.storagegateway#FileSystemAssociationARNList": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#FileSystemAssociationARN" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.storagegateway#FileSystemAssociationId": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 30 } } }, "com.amazonaws.storagegateway#FileSystemAssociationInfo": { "type": "structure", "members": { "FileSystemAssociationARN": { "target": "com.amazonaws.storagegateway#FileSystemAssociationARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file system association.
" } }, "LocationARN": { "target": "com.amazonaws.storagegateway#FileSystemLocationARN", "traits": { "smithy.api#documentation": "The ARN of the backend Amazon FSx file system used for storing file data. For\n information, see FileSystem in the\n Amazon FSx API Reference.
" } }, "FileSystemAssociationStatus": { "target": "com.amazonaws.storagegateway#FileSystemAssociationStatus", "traits": { "smithy.api#documentation": "The status of the file system association. Valid Values: AVAILABLE |\n CREATING | DELETING | FORCE_DELETING |\n UPDATING | ERROR\n
The Amazon Resource Name (ARN) of the storage used for the audit logs.
" } }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { "smithy.api#documentation": "A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key\n name. Each tag is a key-value pair.
" } }, "CacheAttributes": { "target": "com.amazonaws.storagegateway#CacheAttributes" }, "EndpointNetworkConfiguration": { "target": "com.amazonaws.storagegateway#EndpointNetworkConfiguration", "traits": { "smithy.api#documentation": "Specifies network configuration information for the gateway associated with the Amazon FSx file system.
\nIf multiple file systems are associated with this gateway, this parameter's\n IpAddresses field is required.
An array containing the FileSystemAssociationStatusDetail data type, which provides\n detailed information on file system association status.
" } } }, "traits": { "smithy.api#documentation": "Describes the object returned by DescribeFileSystemAssociations that\n describes a created file system association.
The error code for a given file system association status.
" } } }, "traits": { "smithy.api#documentation": "Detailed information on file system association status.
" } }, "com.amazonaws.storagegateway#FileSystemAssociationStatusDetails": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#FileSystemAssociationStatusDetail" } }, "com.amazonaws.storagegateway#FileSystemAssociationSummary": { "type": "structure", "members": { "FileSystemAssociationId": { "target": "com.amazonaws.storagegateway#FileSystemAssociationId", "traits": { "smithy.api#documentation": "The ID of the file system association.
" } }, "FileSystemAssociationARN": { "target": "com.amazonaws.storagegateway#FileSystemAssociationARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file system association.
" } }, "FileSystemAssociationStatus": { "target": "com.amazonaws.storagegateway#FileSystemAssociationStatus", "traits": { "smithy.api#documentation": "The status of the file share. Valid Values: AVAILABLE |\n CREATING | DELETING | FORCE_DELETING |\n UPDATING | ERROR\n
Gets the summary returned by ListFileSystemAssociation, which is a summary\n of a created file system association.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Amazon Web Services Region.
", "smithy.api#length": { "min": 50, "max": 500 } } }, "com.amazonaws.storagegateway#GatewayCapacity": { "type": "enum", "members": { "Small": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Small" } }, "Medium": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Medium" } }, "Large": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Large" } } } }, "com.amazonaws.storagegateway#GatewayId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 30 } } }, "com.amazonaws.storagegateway#GatewayInfo": { "type": "structure", "members": { "GatewayId": { "target": "com.amazonaws.storagegateway#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.
" } }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Amazon Web Services Region.
" } }, "GatewayType": { "target": "com.amazonaws.storagegateway#GatewayType", "traits": { "smithy.api#documentation": "The type of the gateway.
\nAmazon FSx File Gateway is no longer available to new customers. Existing\n customers of FSx File Gateway can continue to use the service normally. For\n capabilities similar to FSx File Gateway, visit this blog post.
\nThe state of the gateway.
\nValid Values: DISABLED | ACTIVE\n
The name of the gateway.
" } }, "Ec2InstanceId": { "target": "com.amazonaws.storagegateway#Ec2InstanceId", "traits": { "smithy.api#documentation": "The ID of the Amazon EC2 instance that was used to launch the gateway.
" } }, "Ec2InstanceRegion": { "target": "com.amazonaws.storagegateway#Ec2InstanceRegion", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where the Amazon EC2 instance is located.
" } }, "HostEnvironment": { "target": "com.amazonaws.storagegateway#HostEnvironment", "traits": { "smithy.api#documentation": "The type of hardware or software platform on which the gateway is running.
\nTape Gateway is no longer available on Snow Family devices.
\nA unique identifier for the specific instance of the host platform running the gateway.\n This value is only available for certain host environments, and its format depends on the\n host environment type.
" } }, "DeprecationDate": { "target": "com.amazonaws.storagegateway#DeprecationDate", "traits": { "smithy.api#documentation": "Date after which this gateway will not receive software updates for new features and bug\n fixes.
" } }, "SoftwareVersion": { "target": "com.amazonaws.storagegateway#SoftwareVersion", "traits": { "smithy.api#documentation": "The version number of the software running on the gateway appliance.
" } } }, "traits": { "smithy.api#documentation": "Describes a gateway object.
" } }, "com.amazonaws.storagegateway#GatewayName": { "type": "string", "traits": { "smithy.api#documentation": "The name you configured for your gateway.
", "smithy.api#length": { "min": 2, "max": 255 }, "smithy.api#pattern": "^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$" } }, "com.amazonaws.storagegateway#GatewayNetworkInterfaces": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#NetworkInterface" } }, "com.amazonaws.storagegateway#GatewayOperationalState": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 25 } } }, "com.amazonaws.storagegateway#GatewayState": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 25 } } }, "com.amazonaws.storagegateway#GatewayTimezone": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 10 } } }, "com.amazonaws.storagegateway#GatewayType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 20 } } }, "com.amazonaws.storagegateway#Gateways": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#GatewayInfo" } }, "com.amazonaws.storagegateway#Host": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 1024 }, "smithy.api#pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])(:(\\d+))?$|^(?:\\[(?:(?:(?:[A-Fa-f0-9]{1,4}:){6}|(?=(?:[A-Fa-f0-9]{0,4}:){0,6}(?:[0-9]{1,3}\\.){3}[0-9]{1,3}(?![:.\\w]))(?:(?:[0-9A-Fa-f]{1,4}:){0,5}|:)(?:(?::[0-9A-Fa-f]{1,4}){1,5}:|:)|::(?:[A-Fa-f0-9]{1,4}:){5})(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}|(?=(?:[A-Fa-f0-9]{0,4}:){0,7}[A-Fa-f0-9]{0,4}(?![:.\\w]))(?:(?:[0-9A-Fa-f]{1,4}:){1,7}|:)(?:(:[0-9A-Fa-f]{1,4}){1,7}|:)|(?:[A-Fa-f0-9]{1,4}:){7}:|:(:[A-Fa-f0-9]{1,4}){7})\\]:\\d+$|^(?:(?:(?:[A-Fa-f0-9]{1,4}:){6}|(?=(?:[A-Fa-f0-9]{0,4}:){0,6}(?:[0-9]{1,3}\\.){3}[0-9]{1,3}(?![:.\\w]))(?:(?:[0-9A-Fa-f]{1,4}:){0,5}|:)(?:(?::[0-9A-Fa-f]{1,4}){1,5}:|:)|::(?:[A-Fa-f0-9]{1,4}:){5})(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}|(?=(?:[A-Fa-f0-9]{0,4}:){0,7}[A-Fa-f0-9]{0,4}(?![:.\\w]))(?:(?:[0-9A-Fa-f]{1,4}:){1,7}|:)(?:(:[0-9A-Fa-f]{1,4}){1,7}|:)|(?:[A-Fa-f0-9]{1,4}:){7}:|:(:[A-Fa-f0-9]{1,4}){7})$)$" } }, "com.amazonaws.storagegateway#HostEnvironment": { "type": "enum", "members": { "VMWARE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VMWARE" } }, "HYPER_V": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HYPER-V" } }, "EC2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EC2" } }, "KVM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KVM" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } }, "SNOWBALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SNOWBALL" } } } }, "com.amazonaws.storagegateway#HostEnvironmentId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.storagegateway#Hosts": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#Host" } }, "com.amazonaws.storagegateway#HourOfDay": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 23 } } }, "com.amazonaws.storagegateway#IPV4Address": { "type": "string", "traits": { "smithy.api#length": { "min": 7, "max": 15 }, "smithy.api#pattern": "^((25[0-5]|(2[0-4]|1[0-9]|[1-9]|)[0-9])(\\.(?!$)|$)){4}$" } }, "com.amazonaws.storagegateway#Initiator": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.storagegateway#Initiators": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#Initiator" } }, "com.amazonaws.storagegateway#InternalServerError": { "type": "structure", "members": { "message": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "A human-readable message describing the error that occurred.
" } }, "error": { "target": "com.amazonaws.storagegateway#StorageGatewayError", "traits": { "smithy.api#documentation": "A StorageGatewayError that provides more information about the cause\n of the error.
" } } }, "traits": { "smithy.api#documentation": "An internal server error has occurred during the request. For more information, see the\n error and message fields.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.storagegateway#InvalidGatewayRequestException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "A human-readable message describing the error that occurred.
" } }, "error": { "target": "com.amazonaws.storagegateway#StorageGatewayError", "traits": { "smithy.api#documentation": "A StorageGatewayError that provides more detail about the cause of the\n error.
" } } }, "traits": { "smithy.api#documentation": "An exception occurred because an invalid gateway request was issued to the service. For\n more information, see the error and message fields.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.storagegateway#IpAddressList": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#IPV4Address" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.storagegateway#Ipv4OrIpv6AddressCIDR": { "type": "string", "traits": { "smithy.api#pattern": "^(?:(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(?:\\/(?:[0-9]|[1-2][0-9]|3[0-2]))?$|^(?:(?:(?:[A-Fa-f0-9]{1,4}:){6}|(?=(?:[A-Fa-f0-9]{0,4}:){0,6}(?:[0-9]{1,3}\\.){3}[0-9]{1,3}(?![:.\\w]))(?:(?:[0-9A-Fa-f]{1,4}:){0,5}|:)(?:(?::[0-9A-Fa-f]{1,4}){1,5}:|:)|::(?:[A-Fa-f0-9]{1,4}:){5})(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}|(?=(?:[A-Fa-f0-9]{0,4}:){0,7}[A-Fa-f0-9]{0,4}(?![:.\\w]))(?:(?:[0-9A-Fa-f]{1,4}:){1,7}|:)(?:(:[0-9A-Fa-f]{1,4}){1,7}|:)|(?:[A-Fa-f0-9]{1,4}:){7}:|:(:[A-Fa-f0-9]{1,4}){7})(?:\\/(?:12[0-8]|1[01][0-9]|[1-9]?[0-9]))?$" } }, "com.amazonaws.storagegateway#IqnName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[0-9a-z:.-]+$" } }, "com.amazonaws.storagegateway#JoinDomain": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#JoinDomainInput" }, "output": { "target": "com.amazonaws.storagegateway#JoinDomainOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Adds a file gateway to an Active Directory domain. This operation is only supported for\n file gateways that support the SMB file protocol.
\nJoining a domain creates an Active Directory computer account in the default\n organizational unit, using the gateway's Gateway ID as\n the account name (for example, SGW-1234ADE). If your Active Directory environment\n requires that you pre-stage accounts to facilitate the join domain process, you will\n need to create this account ahead of time.
\nTo create the gateway's computer account in an organizational unit other than the\n default, you must specify the organizational unit when joining the domain.
\nThe Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Amazon Web Services Region.
The name of the domain that you want the gateway to join.
", "smithy.api#required": {} } }, "OrganizationalUnit": { "target": "com.amazonaws.storagegateway#OrganizationalUnit", "traits": { "smithy.api#documentation": "The organizational unit (OU) is a container in an Active Directory that can hold users,\n groups, computers, and other OUs and this parameter specifies the OU that the gateway will\n join within the AD domain.
" } }, "DomainControllers": { "target": "com.amazonaws.storagegateway#Hosts", "traits": { "smithy.api#documentation": "List of IP addresses, NetBIOS names, or host names of your domain server. If you need to\n specify the port number include it after the colon (\u201c:\u201d). For example,\n mydc.mydomain.com:389.
S3 File Gateway supports IPv6 addresses in addition to IPv4 and other existing\n formats.
\nFSx File Gateway does not support IPv6.
\nSpecifies the time in seconds, in which the JoinDomain operation must\n complete. The default is 20 seconds.
Sets the user name of user who has permission to add the gateway to the Active Directory\n domain. The domain user account should be enabled to join computers to the domain. For\n example, you can use the domain administrator account or an account with delegated\n permissions to join computers to the domain.
", "smithy.api#required": {} } }, "Password": { "target": "com.amazonaws.storagegateway#DomainUserPassword", "traits": { "smithy.api#documentation": "Sets the password of the user who has permission to add the gateway to the Active\n Directory domain.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "JoinDomainInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#JoinDomainOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the gateway that joined the domain.
" } }, "ActiveDirectoryStatus": { "target": "com.amazonaws.storagegateway#ActiveDirectoryStatus", "traits": { "smithy.api#documentation": "Indicates the status of the gateway as a member of the Active Directory domain.
\nThis field is only used as part of a JoinDomain request. It is not\n affected by Active Directory connectivity changes that occur after the\n JoinDomain request succeeds.
\n ACCESS_DENIED: Indicates that the JoinDomain operation\n failed due to an authentication error.
\n DETACHED: Indicates that gateway is not joined to a domain.
\n JOINED: Indicates that the gateway has successfully joined a\n domain.
\n JOINING: Indicates that a JoinDomain operation is in\n progress.
\n INSUFFICIENT_PERMISSIONS: Indicates that the JoinDomain\n operation failed because the specified user lacks the necessary permissions to join\n the domain.
\n NETWORK_ERROR: Indicates that JoinDomain operation\n failed due to a network or connectivity error.
\n TIMEOUT: Indicates that the JoinDomain operation failed\n because the operation didn't complete within the allotted time.
\n UNKNOWN_ERROR: Indicates that the JoinDomain operation\n failed due to another type of error.
JoinDomainOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#KMSKey": { "type": "string", "traits": { "smithy.api#documentation": "Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used\n for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric\n CMKs. This value must be set if KMSEncrypted is true, or if\n EncryptionType is SseKms or DsseKms.
Lists the automatic tape creation policies for a gateway. If there are no automatic tape\n creation policies for the gateway, it returns an empty list.
\nThis operation is only supported for tape gateways.
" } }, "com.amazonaws.storagegateway#ListAutomaticTapeCreationPoliciesInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#ListAutomaticTapeCreationPoliciesOutput": { "type": "structure", "members": { "AutomaticTapeCreationPolicyInfos": { "target": "com.amazonaws.storagegateway#AutomaticTapeCreationPolicyInfos", "traits": { "smithy.api#documentation": "Gets a listing of information about the gateway's automatic tape creation policies,\n including the automatic tape creation rules and the gateway that is using the\n policies.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#ListCacheReports": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#ListCacheReportsInput" }, "output": { "target": "com.amazonaws.storagegateway#ListCacheReportsOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns a list of existing cache reports for all file shares associated with your\n Amazon Web Services account. This list includes all information provided by the\n DescribeCacheReport action, such as report name, status, completion\n progress, start time, end time, filters, and tags.
Opaque pagination token returned from a previous ListCacheReports\n operation. If present, Marker specifies where to continue the list from after\n a previous call to ListCacheReports. Optional.
A list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the\n DescribeCacheReport action, such as report status, completion progress,\n start time, end time, filters, and tags.
If the request includes Marker, the response returns that value in this\n field.
Gets a list of the file shares for a specific S3 File Gateway, or the list of file\n shares that belong to the calling Amazon Web Services account. This operation is only\n supported for S3 File Gateways.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", "items": "FileShareInfoList", "pageSize": "Limit" } } }, "com.amazonaws.storagegateway#ListFileSharesInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If\n this field is not present, all file shares under your account are listed.
" } }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { "smithy.api#documentation": "The maximum number of file shares to return in the response. The value must be an\n integer with a value greater than zero. Optional.
" } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "Opaque pagination token returned from a previous ListFileShares operation. If present,\n Marker specifies where to continue the list from after a previous call to\n ListFileShares. Optional.
ListFileShareInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#ListFileSharesOutput": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "If the request includes Marker, the response returns that value in this\n field.
If a value is present, there are more file shares to return. In a subsequent request,\n use NextMarker as the value for Marker to retrieve the next set\n of file shares.
An array of information about the S3 File Gateway's file shares.
" } } }, "traits": { "smithy.api#documentation": "ListFileShareOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#ListFileSystemAssociations": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#ListFileSystemAssociationsInput" }, "output": { "target": "com.amazonaws.storagegateway#ListFileSystemAssociationsOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Gets a list of FileSystemAssociationSummary objects. Each object contains a\n summary of a file system association. This operation is only supported for FSx File\n Gateways.
The maximum number of file system associations to return in the response. If present,\n Limit must be an integer with a value greater than zero. Optional.
Opaque pagination token returned from a previous ListFileSystemAssociations\n operation. If present, Marker specifies where to continue the list from after\n a previous call to ListFileSystemAssociations. Optional.
If the request includes Marker, the response returns that value in this\n field.
If a value is present, there are more file system associations to return. In a\n subsequent request, use NextMarker as the value for Marker to\n retrieve the next set of file system associations.
An array of information about the Amazon FSx gateway's file system\n associations.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#ListGateways": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#ListGatewaysInput" }, "output": { "target": "com.amazonaws.storagegateway#ListGatewaysOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region\n specified in the request. The returned list is ordered by gateway Amazon Resource Name\n (ARN).
\nBy default, the operation returns a maximum of 100 gateways. This operation supports\n pagination that allows you to optionally reduce the number of gateways returned in a\n response.
\nIf you have more gateways than are returned in a response (that is, the response returns\n only a truncated list of your gateways), the response contains a marker that you can\n specify in your next request to fetch the next page of gateways.
", "smithy.api#examples": [ { "title": "To lists region specific gateways per AWS account", "documentation": "Lists gateways owned by an AWS account in a specified region as requested. Results are sorted by gateway ARN up to a maximum of 100 gateways.", "input": { "Marker": "1", "Limit": 2 }, "output": { "Gateways": [ { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" }, { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C" } ], "Marker": "1" } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Gateways", "pageSize": "Limit" } } }, "com.amazonaws.storagegateway#ListGatewaysInput": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which to begin the returned list of\n gateways.
" } }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { "smithy.api#documentation": "Specifies that the list of gateways returned be limited to the specified number of\n items.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing zero or more of the following fields:
\nAn array of GatewayInfo objects.
" } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "Use the marker in your next request to fetch the next set of gateways in the list. If\n there are no more gateways to list, this field does not appear in the response.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#ListLocalDisks": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#ListLocalDisksInput" }, "output": { "target": "com.amazonaws.storagegateway#ListLocalDisksOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Returns a list of the gateway's local disks. To specify which gateway to describe,\n you use the Amazon Resource Name (ARN) of the gateway in the body of the request.
\nThe request returns a list of all disks, specifying which are configured as working\n storage, cache storage, or stored volume or not configured at all. The response includes a\n DiskStatus field. This field can have a value of present (the disk is\n available to use), missing (the disk is no longer connected to the gateway), or mismatch\n (the disk node is occupied by a disk that has incorrect metadata or the disk content is\n corrupted).
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#ListLocalDisksOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "Disks": { "target": "com.amazonaws.storagegateway#Disks", "traits": { "smithy.api#documentation": "A JSON object containing the following fields:
\nLists the tags that have been added to the specified resource. This operation is\n supported in storage gateways of all types.
", "smithy.api#examples": [ { "title": "To list tags that have been added to a resource", "documentation": "Lists the tags that have been added to the specified resource.", "input": { "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", "Marker": "1", "Limit": 1 }, "output": { "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", "Marker": "1", "Tags": [ { "Key": "Dev Gatgeway Region", "Value": "East Coast" } ] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Tags", "pageSize": "Limit" } } }, "com.amazonaws.storagegateway#ListTagsForResourceInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.storagegateway#ResourceARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which you want to list tags.
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which to begin returning the list of\n tags.
" } }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { "smithy.api#documentation": "Specifies that the list of tags returned be limited to the specified number of\n items.
" } } }, "traits": { "smithy.api#documentation": "ListTagsForResourceInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#ListTagsForResourceOutput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.storagegateway#ResourceARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which you want to list tags.
" } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which to stop returning the list of\n tags.
" } }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { "smithy.api#documentation": "An array that contains the tags for the specified resource.
" } } }, "traits": { "smithy.api#documentation": "ListTagsForResourceOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#ListTapePools": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#ListTapePoolsInput" }, "output": { "target": "com.amazonaws.storagegateway#ListTapePoolsOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Lists custom tape pools. You specify custom tape pools to list by specifying one or more\n custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN,\n the operation lists all custom tape pools.
\nThis operation supports pagination. You can optionally specify the Limit\n parameter in the body to limit the number of tape pools in the response. If the number of\n tape pools returned in the response is truncated, the response includes a\n Marker element that you can use in your subsequent request to retrieve the\n next set of tape pools.
The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you\n don't specify a custom tape pool ARN, the response lists all custom tape pools.
" } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "A string that indicates the position at which to begin the returned list of tape\n pools.
" } }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { "smithy.api#documentation": "An optional number limit for the tape pools in the list returned by this call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#ListTapePoolsOutput": { "type": "structure", "members": { "PoolInfos": { "target": "com.amazonaws.storagegateway#PoolInfos", "traits": { "smithy.api#documentation": "An array of PoolInfo objects, where each object describes a single custom\n tape pool. If there are no custom tape pools, the PoolInfos is an empty array.\n
A string that indicates the position at which to begin the returned list of tape pools.\n Use the marker in your next request to continue pagination of tape pools. If there are no\n more tape pools to list, this element does not appear in the response body.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#ListTapes": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#ListTapesInput" }, "output": { "target": "com.amazonaws.storagegateway#ListTapesOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf\n (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names\n (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both\n your VTL and VTS.
\nThis operation supports pagination. By default, the operation returns a maximum of up to\n 100 tapes. You can optionally specify the Limit parameter in the body to limit\n the number of tapes in the response. If the number of tapes returned in the response is\n truncated, the response includes a Marker element that you can use in your\n subsequent request to retrieve the next set of tapes. This operation is only supported in\n the tape gateway type.
A string that indicates the position at which to begin the returned list of\n tapes.
" } }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { "smithy.api#documentation": "An optional number limit for the tapes in the list returned by this call.
" } } }, "traits": { "smithy.api#documentation": "A JSON object that contains one or more of the following fields:
\n\n ListTapesInput$Limit\n
\nA string that indicates the position at which to begin returning the next list of tapes.\n Use the marker in your next request to continue pagination of tapes. If there are no more\n tapes to list, this element does not appear in the response body.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing the following fields:
\nLists iSCSI initiators that are connected to a volume. You can use this operation to\n determine whether a volume is being used or not. This operation is only supported in the\n cached volume and stored volume gateway types.
" } }, "com.amazonaws.storagegateway#ListVolumeInitiatorsInput": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume. Use the ListVolumes\n operation to return a list of gateway volumes for the gateway.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "ListVolumeInitiatorsInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#ListVolumeInitiatorsOutput": { "type": "structure", "members": { "Initiators": { "target": "com.amazonaws.storagegateway#Initiators", "traits": { "smithy.api#documentation": "The host names and port numbers of all iSCSI initiators that are connected to the\n gateway.
" } } }, "traits": { "smithy.api#documentation": "ListVolumeInitiatorsOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#ListVolumeRecoveryPoints": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#ListVolumeRecoveryPointsInput" }, "output": { "target": "com.amazonaws.storagegateway#ListVolumeRecoveryPointsOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Lists the recovery points for a specified gateway. This operation is only supported in\n the cached volume gateway type.
\nEach cache volume has one recovery point. A volume recovery point is a point in time at\n which all data of the volume is consistent and from which you can create a snapshot or\n clone a new cached volume from a source volume. To create a snapshot from a volume recovery\n point use the CreateSnapshotFromVolumeRecoveryPoint operation.
", "smithy.api#examples": [ { "title": "To list recovery points for a gateway", "documentation": "Lists the recovery points for a specified gateway in which all data of the volume is consistent and can be used to create a snapshot.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "VolumeRecoveryPointInfos": [ { "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", "VolumeRecoveryPointTime": "2012-09-04T21:08:44.627Z", "VolumeSizeInBytes": 536870912000 } ] } } ] } }, "com.amazonaws.storagegateway#ListVolumeRecoveryPointsInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#ListVolumeRecoveryPointsOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "VolumeRecoveryPointInfos": { "target": "com.amazonaws.storagegateway#VolumeRecoveryPointInfos", "traits": { "smithy.api#documentation": "An array of VolumeRecoveryPointInfo objects.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#ListVolumes": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#ListVolumesInput" }, "output": { "target": "com.amazonaws.storagegateway#ListVolumesOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The\n response includes only the volume ARNs. If you want additional volume information, use the\n DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.
\nThe operation supports pagination. By default, the operation returns a maximum of up to\n 100 volumes. You can optionally specify the Limit field in the body to limit\n the number of volumes in the response. If the number of volumes returned in the response is\n truncated, the response includes a Marker field. You can use this Marker value in your\n subsequent request to retrieve the next set of volumes. This operation is only supported in\n the cached volume and stored volume gateway types.
A string that indicates the position at which to begin the returned list of volumes.\n Obtain the marker from the response of a previous List iSCSI Volumes request.
" } }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { "smithy.api#documentation": "Specifies that the list of volumes returned be limited to the specified number of\n items.
" } } }, "traits": { "smithy.api#documentation": "A JSON object that contains one or more of the following fields:
\nUse the marker in your next request to continue pagination of iSCSI volumes. If there\n are no more volumes to list, this field does not appear in the response body.
" } }, "VolumeInfos": { "target": "com.amazonaws.storagegateway#VolumeInfos", "traits": { "smithy.api#documentation": "An array of VolumeInfo objects, where each object describes an iSCSI\n volume. If no volumes are defined for the gateway, then VolumeInfos is an\n empty array \"[]\".
A JSON object containing the following fields:
\nA custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).
\nYou can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.
\nBucket ARN:
\n\n arn:aws:s3:::amzn-s3-demo-bucket/prefix/\n
Access point ARN:
\n\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n
If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
\nAccess point alias:
\n\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n
The Unix file mode in the form \"nnnn\". For example, 0666 represents the\n default file mode inside the file share. The default value is 0666.
The Unix directory mode in the form \"nnnn\". For example, 0666 represents\n the default access mode for all directories inside the file share. The default value is\n 0777.
The default group ID for the file share (unless the files have another group ID\n specified). The default value is nfsnobody.
The default owner ID for files in the file share (unless the files have another owner ID\n specified). The default value is nfsnobody.
Describes Network File System (NFS) file share default values. Files and folders stored\n as Amazon S3 objects in S3 buckets don't, by default, have Unix file\n permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3\n objects that represent files and folders are assigned these default Unix permissions. This\n operation is only supported for S3 File Gateways.
" } }, "com.amazonaws.storagegateway#NFSFileShareInfo": { "type": "structure", "members": { "NFSFileShareDefaults": { "target": "com.amazonaws.storagegateway#NFSFileShareDefaults" }, "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN" }, "FileShareId": { "target": "com.amazonaws.storagegateway#FileShareId" }, "FileShareStatus": { "target": "com.amazonaws.storagegateway#FileShareStatus" }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "EncryptionType": { "target": "com.amazonaws.storagegateway#EncryptionType", "traits": { "smithy.api#documentation": "A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.
Valid Values: true | false\n
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.
Valid Values: true | false\n
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true | false\n
A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource API operation.
The name of the file share. Optional.
\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
Refresh cache information for the file share.
" } }, "NotificationPolicy": { "target": "com.amazonaws.storagegateway#NotificationPolicy", "traits": { "smithy.api#documentation": "The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to\n Amazon S3.
\nThis parameter is required for NFS file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies the Region of the S3 bucket where the NFS file share stores files.
\nThis parameter is required for NFS file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nThe Amazon Resource Name (ARN) of the storage used for audit logs.
" } } }, "traits": { "smithy.api#documentation": "The Unix file permissions and ownership information assigned, by default, to native S3\n objects when an S3 File Gateway discovers them in S3 buckets. This operation is only\n supported in S3 File Gateways.
" } }, "com.amazonaws.storagegateway#NFSFileShareInfoList": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#NFSFileShareInfo" } }, "com.amazonaws.storagegateway#NetworkInterface": { "type": "structure", "members": { "Ipv4Address": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "The Internet Protocol version 4 (IPv4) address of the interface.
" } }, "MacAddress": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "The Media Access Control (MAC) address of the interface.
\nThis is currently unsupported and will not be returned in output.
\nThe Internet Protocol version 6 (IPv6) address of the interface.
\nThis element returns IPv6 addresses for all gateway types except FSx File Gateway.
\nDescribes a gateway's network interface.
", "smithy.api#sensitive": {} } }, "com.amazonaws.storagegateway#NetworkInterfaceId": { "type": "string" }, "com.amazonaws.storagegateway#NextUpdateAvailabilityDate": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.storagegateway#NotificationId": { "type": "string", "traits": { "smithy.api#documentation": "The randomly generated ID of the notification that was sent. This ID is in UUID\n format.
", "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.storagegateway#NotificationPolicy": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 100 }, "smithy.api#pattern": "^\\{[\\w\\s:\\{\\}\\[\\]\"]*}$" } }, "com.amazonaws.storagegateway#NotifyWhenUploaded": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#NotifyWhenUploadedInput" }, "output": { "target": "com.amazonaws.storagegateway#NotifyWhenUploadedOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Sends you notification through Amazon EventBridge when all files written to your file\n share have been uploaded to Amazon S3.
\nStorage Gateway can send a notification through Amazon EventBridge when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through EventBridge. You can configure EventBridge to send the\n notification through event targets such as Amazon SNS or Lambda\n function. This operation is only supported for S3 File Gateways.
\nFor more information, see Getting\n file upload notification in the Amazon S3 File Gateway User\n Guide.
" } }, "com.amazonaws.storagegateway#NotifyWhenUploadedInput": { "type": "structure", "members": { "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#NotifyWhenUploadedOutput": { "type": "structure", "members": { "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN" }, "NotificationId": { "target": "com.amazonaws.storagegateway#NotificationId" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#NumTapesToCreate": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.storagegateway#ObjectACL": { "type": "enum", "members": { "private": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "private" } }, "public_read": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "public-read" } }, "public_read_write": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "public-read-write" } }, "authenticated_read": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "authenticated-read" } }, "bucket_owner_read": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "bucket-owner-read" } }, "bucket_owner_full_control": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "bucket-owner-full-control" } }, "aws_exec_read": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "aws-exec-read" } } }, "traits": { "smithy.api#documentation": "A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that an S3 File Gateway puts objects into. The default value is\n private.
The file share path used by the NFS client to identify the mount point.
" } }, "com.amazonaws.storagegateway#PermissionId": { "type": "long", "traits": { "smithy.api#range": { "min": 0, "max": 4294967294 } } }, "com.amazonaws.storagegateway#PermissionMode": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4 }, "smithy.api#pattern": "^[0-7]{4}$" } }, "com.amazonaws.storagegateway#PoolARN": { "type": "string", "traits": { "smithy.api#length": { "min": 50, "max": 500 } } }, "com.amazonaws.storagegateway#PoolARNs": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#PoolARN" } }, "com.amazonaws.storagegateway#PoolId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.storagegateway#PoolInfo": { "type": "structure", "members": { "PoolARN": { "target": "com.amazonaws.storagegateway#PoolARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your\n account and Amazon Web Services Region.
" } }, "PoolName": { "target": "com.amazonaws.storagegateway#PoolName", "traits": { "smithy.api#documentation": "The name of the custom tape pool. PoolName can use all ASCII characters,\n except '/' and '\\'.
The storage class that is associated with the custom pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
" } }, "RetentionLockType": { "target": "com.amazonaws.storagegateway#RetentionLockType", "traits": { "smithy.api#documentation": "Tape retention lock type, which can be configured in two modes. When configured in\n governance mode, Amazon Web Services accounts with specific IAM permissions are authorized\n to remove the tape retention lock from archived virtual tapes. When configured in\n compliance mode, the tape retention lock cannot be removed by any user, including the root\n Amazon Web Services account.
" } }, "RetentionLockTimeInDays": { "target": "com.amazonaws.storagegateway#RetentionLockTimeInDays", "traits": { "smithy.api#documentation": "Tape retention lock time is set in days. Tape retention lock can be enabled for up to\n 100 years (36,500 days).
" } }, "PoolStatus": { "target": "com.amazonaws.storagegateway#PoolStatus", "traits": { "smithy.api#documentation": "Status of the custom tape pool. Pool can be ACTIVE or\n DELETED.
Describes a custom tape pool.
" } }, "com.amazonaws.storagegateway#PoolInfos": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#PoolInfo" } }, "com.amazonaws.storagegateway#PoolName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$" } }, "com.amazonaws.storagegateway#PoolStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.storagegateway#PositiveIntObject": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.storagegateway#RecurrenceInHours": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 24 } } }, "com.amazonaws.storagegateway#RefreshCache": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#RefreshCacheInput" }, "output": { "target": "com.amazonaws.storagegateway#RefreshCacheOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.
\nYou can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache operation completes. For more information, see Getting\n notified about file operations in the Amazon S3 File Gateway User\n Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache\n operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting\n notified about file operations in the Amazon S3 File Gateway User\n Guide.
\nWait at least 60 seconds between consecutive RefreshCache API requests.
\nIf you invoke the RefreshCache API when two requests are already being\n processed, any new request will cause an\n InvalidGatewayRequestException error because too many requests\n were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in\n the FolderList parameter.
\nFor more information, see Getting\n notified about file operations in the Amazon S3 File Gateway User\n Guide.
" } }, "com.amazonaws.storagegateway#RefreshCacheInput": { "type": "structure", "members": { "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file share you want to refresh.
", "smithy.api#required": {} } }, "FolderList": { "target": "com.amazonaws.storagegateway#FolderList", "traits": { "smithy.api#documentation": "A comma-separated list of the paths of folders to refresh in the cache. The default is\n [\"/\"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true, the entire S3\n bucket that the file share has access to is refreshed.
Do not include / when specifying folder names. For example, you would\n specify samplefolder rather than samplefolder/.
A value that specifies whether to recursively refresh folders in the cache. The refresh\n includes folders that were in the cache the last time the gateway listed the folder's\n contents. If this value set to true, each folder that is listed in\n FolderList is recursively updated. Otherwise, subfolders listed in\n FolderList are not refreshed. Only objects that are in folders listed\n directly under FolderList are found and used for the update. The default is\n true.
Valid Values: true | false\n
RefreshCacheInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#RefreshCacheOutput": { "type": "structure", "members": { "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN" }, "NotificationId": { "target": "com.amazonaws.storagegateway#NotificationId" } }, "traits": { "smithy.api#documentation": "RefreshCacheOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#RegionId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.storagegateway#RemoveTagsFromResource": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#RemoveTagsFromResourceInput" }, "output": { "target": "com.amazonaws.storagegateway#RemoveTagsFromResourceOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Removes one or more tags from the specified resource. This operation is supported in\n storage gateways of all types.
", "smithy.api#examples": [ { "title": "To remove tags from a resource", "documentation": "Lists the iSCSI stored volumes of a gateway. Removes one or more tags from the specified resource.", "input": { "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", "TagKeys": [ "Dev Gatgeway Region", "East Coast" ] }, "output": { "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" } } ] } }, "com.amazonaws.storagegateway#RemoveTagsFromResourceInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.storagegateway#ResourceARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource you want to remove the tags from.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.storagegateway#TagKeys", "traits": { "smithy.api#documentation": "The keys of the tags you want to remove from the specified resource. A tag is composed\n of a key-value pair.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "RemoveTagsFromResourceInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#RemoveTagsFromResourceOutput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.storagegateway#ResourceARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that the tags were removed from.
" } } }, "traits": { "smithy.api#documentation": "RemoveTagsFromResourceOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#ReportCompletionPercent": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.storagegateway#ResetCache": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#ResetCacheInput" }, "output": { "target": "com.amazonaws.storagegateway#ResetCacheOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Resets all cache disks that have encountered an error and makes the disks available for\n reconfiguration as cache storage. If your cache disk encounters an error, the gateway\n prevents read and write operations on virtual tapes in the gateway. For example, an error\n can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the\n gateway loses its cache storage. At this point, you can reconfigure the disks as cache\n disks. This operation is only supported in the cached volume and tape types.
\nIf the cache disk you are resetting contains data that has not been uploaded to\n Amazon S3 yet, that data can be lost. After you reset cache disks, there will\n be no configured cache disks left in the gateway, so you must configure at least one new\n cache disk for your gateway to function properly.
\nRetrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.\n Virtual tapes archived in the VTS are not associated with any gateway. However after a tape\n is retrieved, it is associated with a gateway, even though it is also listed in the VTS,\n that is, archive. This operation is only supported in the tape gateway type.
\nOnce a tape is successfully retrieved to a gateway, it cannot be retrieved again to\n another gateway. You must archive the tape again before you can retrieve it to another\n gateway. This operation is only supported in the tape gateway type.
", "smithy.api#examples": [ { "title": "To retrieve an archived tape from the VTS", "documentation": "Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway.", "input": { "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF", "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" }, "output": { "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" } } ] } }, "com.amazonaws.storagegateway#RetrieveTapeArchiveInput": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual\n tape shelf (VTS).
", "smithy.api#required": {} } }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to.\n Use the ListGateways operation to return a list of gateways for your\n account and Amazon Web Services Region.
\nYou retrieve archived virtual tapes to only one gateway and the gateway must be a tape\n gateway.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "RetrieveTapeArchiveInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#RetrieveTapeArchiveOutput": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the retrieved virtual tape.
" } } }, "traits": { "smithy.api#documentation": "RetrieveTapeArchiveOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#RetrieveTapeRecoveryPoint": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#RetrieveTapeRecoveryPointInput" }, "output": { "target": "com.amazonaws.storagegateway#RetrieveTapeRecoveryPointOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Retrieves the recovery point for the specified virtual tape. This operation is only\n supported in the tape gateway type.
\nA recovery point is a point in time view of a virtual tape at which all the data on the\n tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be\n recovered to a new gateway.
\nThe virtual tape can be retrieved to only one gateway. The retrieved tape is\n read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge\n for retrieving recovery points.
\nThe Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the\n recovery point.
", "smithy.api#required": {} } }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "RetrieveTapeRecoveryPointInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#RetrieveTapeRecoveryPointOutput": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was\n retrieved.
" } } }, "traits": { "smithy.api#documentation": "RetrieveTapeRecoveryPointOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#Role": { "type": "string", "traits": { "smithy.api#documentation": "The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying\n storage.
", "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*|-eusc)):iam::([0-9]+):role/(\\S+)$" } }, "com.amazonaws.storagegateway#SMBFileShareInfo": { "type": "structure", "members": { "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN" }, "FileShareId": { "target": "com.amazonaws.storagegateway#FileShareId" }, "FileShareStatus": { "target": "com.amazonaws.storagegateway#FileShareStatus" }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "EncryptionType": { "target": "com.amazonaws.storagegateway#EncryptionType", "traits": { "smithy.api#documentation": "A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
The file share path used by the SMB client to identify the mount point.
" } }, "Role": { "target": "com.amazonaws.storagegateway#Role" }, "LocationARN": { "target": "com.amazonaws.storagegateway#LocationARN" }, "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { "smithy.api#documentation": "The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.
Valid Values: true | false\n
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.
Valid Values: true | false\n
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true | false\n
If this value is set to true, it indicates that access control list (ACL)\n is enabled on the SMB file share. If it is set to false, it indicates that\n file and directory permissions are mapped to the POSIX permission.
For more information, see Using Windows ACLs to limit SMB file share\n access in the Amazon S3 File Gateway User\n Guide.
" } }, "AccessBasedEnumeration": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { "smithy.api#documentation": "Indicates whether AccessBasedEnumeration is enabled.
A list of users or groups in the Active Directory that have administrator rights to the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.
A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.
A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.
The Amazon Resource Name (ARN) of the storage used for audit logs.
" } }, "Authentication": { "target": "com.amazonaws.storagegateway#Authentication" }, "CaseSensitivity": { "target": "com.amazonaws.storagegateway#CaseSensitivity", "traits": { "smithy.api#documentation": "The case of an object name in an Amazon S3 bucket. For\n ClientSpecified, the client determines the case sensitivity. For\n CaseSensitive, the gateway determines the case sensitivity. The default\n value is ClientSpecified.
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource API operation.
The name of the file share. Optional.
\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
Refresh cache information for the file share.
" } }, "NotificationPolicy": { "target": "com.amazonaws.storagegateway#NotificationPolicy", "traits": { "smithy.api#documentation": "The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to\n Amazon S3.
\nThis parameter is required for SMB file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies the Region of the S3 bucket where the SMB file share stores files.
\nThis parameter is required for SMB file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies whether opportunistic locking is enabled for the SMB file share.
\nEnabling opportunistic locking on case-sensitive shares is not recommended for\n workloads that involve access to files with the same name in different case.
\nValid Values: true | false\n
The Windows file permissions and ownership information assigned, by default, to native\n S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only\n supported for S3 File Gateways.
" } }, "com.amazonaws.storagegateway#SMBFileShareInfoList": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#SMBFileShareInfo" } }, "com.amazonaws.storagegateway#SMBGuestPassword": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 512 }, "smithy.api#pattern": "^[ -~]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.storagegateway#SMBLocalGroups": { "type": "structure", "members": { "GatewayAdmins": { "target": "com.amazonaws.storagegateway#UserList", "traits": { "smithy.api#documentation": "A list of Active Directory users and groups that have local Gateway Admin permissions.\n Acceptable formats include: DOMAIN\\User1, user1,\n DOMAIN\\group1, and group1.
Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to\n force-close files that are open and locked.
" } } }, "traits": { "smithy.api#documentation": "A list of Active Directory users and groups that have special permissions for SMB file\n shares on the gateway.
" } }, "com.amazonaws.storagegateway#SMBSecurityStrategy": { "type": "enum", "members": { "ClientSpecified": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ClientSpecified" } }, "MandatorySigning": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MandatorySigning" } }, "MandatoryEncryption": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MandatoryEncryption" } }, "MandatoryEncryptionNoAes128": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MandatoryEncryptionNoAes128" } } } }, "com.amazonaws.storagegateway#ServiceUnavailableError": { "type": "structure", "members": { "message": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "A human-readable message describing the error that occurred.
" } }, "error": { "target": "com.amazonaws.storagegateway#StorageGatewayError", "traits": { "smithy.api#documentation": "A StorageGatewayError that provides more information about the cause\n of the error.
" } } }, "traits": { "smithy.api#documentation": "An internal server error has occurred because the service is unavailable. For more\n information, see the error and message fields.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.storagegateway#SetLocalConsolePassword": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#SetLocalConsolePasswordInput" }, "output": { "target": "com.amazonaws.storagegateway#SetLocalConsolePasswordOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Sets the password for your VM local console. When you log in to the local console for\n the first time, you log in to the VM with the default credentials. We recommend that you\n set a new password. You don't need to know the default password to set a new\n password.
", "smithy.api#examples": [ { "title": "To set a password for your VM", "documentation": "Sets the password for your VM local console.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", "LocalConsolePassword": "PassWordMustBeAtLeast6Chars." }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" } } ] } }, "com.amazonaws.storagegateway#SetLocalConsolePasswordInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "LocalConsolePassword": { "target": "com.amazonaws.storagegateway#LocalConsolePassword", "traits": { "smithy.api#documentation": "The password you want to set for your VM local console.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "SetLocalConsolePasswordInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#SetLocalConsolePasswordOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#SetSMBGuestPassword": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#SetSMBGuestPasswordInput" }, "output": { "target": "com.amazonaws.storagegateway#SetSMBGuestPasswordOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Sets the password for the guest user smbguest. The smbguest\n user is the user when the authentication method for the file share is set to\n GuestAccess. This operation only supported for S3 File Gateways
The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file share is associated\n with.
", "smithy.api#required": {} } }, "Password": { "target": "com.amazonaws.storagegateway#SMBGuestPassword", "traits": { "smithy.api#documentation": "The password that you want to set for your SMB server.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "SetSMBGuestPasswordInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#SetSMBGuestPasswordOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#ShutdownGateway": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#ShutdownGatewayInput" }, "output": { "target": "com.amazonaws.storagegateway#ShutdownGatewayOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use\n the Amazon Resource Name (ARN) of the gateway in the body of your request.
\nThis API action cannot be used to shut down S3 File Gateway or FSx File\n Gateway.
\nThe operation shuts down the gateway service component running in the gateway's\n virtual machine (VM) and not the host VM.
\nIf you want to shut down the VM, it is recommended that you first shut down the\n gateway component in the VM to avoid unpredictable conditions.
\nAfter the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway.\n Your applications cannot read from or write to the gateway's storage volumes, and\n there are no snapshots taken.
\nWhen you make a shutdown request, you will get a 200 OK success response\n immediately. However, it might take some time for the gateway to shut down. You can call\n the DescribeGatewayInformation API to check the status. For more\n information, see ActivateGateway.
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the\n gateway.
", "smithy.api#examples": [ { "title": "To shut down a gateway service", "documentation": "This operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" } } ] } }, "com.amazonaws.storagegateway#ShutdownGatewayInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut\n down.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#ShutdownGatewayOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut\n down.
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#SnapshotDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.storagegateway#SnapshotId": { "type": "string", "traits": { "smithy.api#pattern": "^\\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\\z$" } }, "com.amazonaws.storagegateway#SoftwareUpdatePreferences": { "type": "structure", "members": { "AutomaticUpdatePolicy": { "target": "com.amazonaws.storagegateway#AutomaticUpdatePolicy", "traits": { "smithy.api#documentation": "Indicates the automatic update policy for a gateway.
\n\n ALL_VERSIONS - Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The\n gateway will still receive emergency version updates on rare occasions if necessary to\n remedy highly critical security or durability issues. You will be notified before an\n emergency version update is applied. These updates are applied during your gateway's\n scheduled maintenance window.
A set of variables indicating the software update preferences for the gateway.
" } }, "com.amazonaws.storagegateway#SoftwareUpdatesEndDate": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.storagegateway#SoftwareVersion": { "type": "string" }, "com.amazonaws.storagegateway#Squash": { "type": "string", "traits": { "smithy.api#documentation": "The user mapped to anonymous user. Valid options are the following:
\n\n RootSquash: Only root is mapped to anonymous user.
\n NoSquash: No one is mapped to anonymous user.
\n AllSquash: Everyone is mapped to anonymous user.
Start a test that verifies that the specified gateway is configured for High\n Availability monitoring in your host environment. This request only initiates the test and\n that a successful response only indicates that the test was started. It doesn't\n indicate that the test passed. For the status of the test, invoke the\n DescribeAvailabilityMonitorTest API.
Starting this test will cause your gateway to go offline for a brief period.
\nStarts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share. You can use this report to identify and resolve\n issues if you have files failing upload from your gateway to Amazon S3. The report\n is a CSV file containing a list of files which match the set of filter parameters you\n specify in the request.
\nThe Files Failing Upload flag is reset every 24\n hours and during gateway reboot. If this report captures the files after the reset, but\n before they become flagged again, they will not be reported as Files Failing Upload.
\nThe following requirements must be met to successfully generate a cache report:
\nYou must have s3:PutObject and s3:AbortMultipartUpload\n permissions for the Amazon S3 bucket where you want to store the cache\n report.
No other cache reports can currently be in-progress for the specified file\n share.
\nThere must be fewer than 10 existing cache reports for the specified file\n share.
\nThe gateway must be online and connected to Amazon Web Services.
\nThe root disk must have at least 20GB of free space when report generation\n starts.
\nYou must specify at least one value for InclusionFilters or\n ExclusionFilters in the request.
The ARN of the IAM role used when saving the cache report to Amazon S3.
", "smithy.api#required": {} } }, "LocationARN": { "target": "com.amazonaws.storagegateway#LocationARN", "traits": { "smithy.api#documentation": "The ARN of the Amazon S3 bucket where you want to save the cache report.
\nWe do not recommend saving the cache report to the same Amazon S3 bucket for\n which you are generating the report.
\nThis field does not accept access point ARNs.
\nThe Amazon Web Services Region of the Amazon S3 bucket where you want to save the\n cache report.
", "smithy.api#required": {} } }, "VPCEndpointDNSName": { "target": "com.amazonaws.storagegateway#DNSHostName", "traits": { "smithy.api#documentation": "The DNS name of the VPC endpoint associated with the Amazon S3 where you want to\n save the cache report. Optional.
" } }, "InclusionFilters": { "target": "com.amazonaws.storagegateway#CacheReportFilterList", "traits": { "smithy.api#documentation": "The list of filters and parameters that determine which files are included in the\n report. You must specify at least one value for InclusionFilters or\n ExclusionFilters in a StartCacheReport request.
The list of filters and parameters that determine which files are excluded from the\n report. You must specify at least one value for InclusionFilters or\n ExclusionFilters in a StartCacheReport request.
A unique identifier that you use to ensure idempotent report generation if you need to\n retry an unsuccessful StartCacheReport request. If you retry a request, use\n the same ClientToken you specified in the initial request.
A list of up to 50 key/value tags that you can assign to the cache report. Using tags\n can help you categorize your reports and more easily locate them in search results.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#StartCacheReportOutput": { "type": "structure", "members": { "CacheReportARN": { "target": "com.amazonaws.storagegateway#CacheReportARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cache report generated by the\n StartCacheReport request.
Starts a gateway that you previously shut down (see ShutdownGateway).\n After the gateway starts, you can then make other API calls, your applications can read\n from or write to the gateway's storage volumes and you will be able to take snapshot\n backups.
\nWhen you make a request, you will get a 200 OK success response immediately. However,\n it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any\n additional API calls. For more information, see ActivateGateway.
\nTo specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in\n your request.
", "smithy.api#examples": [ { "title": "To start a gateway service", "documentation": "Starts a gateway service that was previously shut down.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" } } ] } }, "com.amazonaws.storagegateway#StartGatewayInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#StartGatewayOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the gateway that was\n restarted.
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#StorageClass": { "type": "string", "traits": { "smithy.api#documentation": "", "smithy.api#length": { "min": 5, "max": 50 } } }, "com.amazonaws.storagegateway#StorageGatewayError": { "type": "structure", "members": { "errorCode": { "target": "com.amazonaws.storagegateway#ErrorCode", "traits": { "smithy.api#documentation": "Additional information about the error.
" } }, "errorDetails": { "target": "com.amazonaws.storagegateway#errorDetails", "traits": { "smithy.api#documentation": "Human-readable text that provides detail about the error that occurred.
" } } }, "traits": { "smithy.api#documentation": "Provides additional information about an error that was returned by the service. See the\n errorCode and errorDetails members for more information about\n the error.
Amazon FSx File Gateway is no longer available to new customers. Existing\n customers of FSx File Gateway can continue to use the service normally. For\n capabilities similar to FSx File Gateway, visit this blog post.
\nStorage Gateway is the service that connects an on-premises software appliance\n with cloud-based storage to provide seamless and secure integration between an\n organization's on-premises IT environment and the Amazon Web Services storage\n infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.
\nUse the following links to get started using the Storage Gateway\n Service API Reference:
\n\n Storage Gateway required request headers: Describes the required\n headers that you must send with every POST request to Storage Gateway.
\n\n Signing requests: Storage Gateway requires that you authenticate\n every request you send; this topic describes how sign such a request.
\n\n Error responses: Provides reference information about Storage Gateway errors.
\n\n Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and\n examples of requests and responses.
\n\n Storage Gateway\n endpoints and quotas: Provides a list of each Amazon Web Services Region\n and the endpoints available for use with Storage Gateway.
\nStorage Gateway resource IDs are in uppercase. When you use these resource IDs\n with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change\n your resource ID to lowercase to use it with the EC2 API. For example, in Storage\n Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use\n this ID with the EC2 API, you must change it to vol-aa22bb012345daf670.\n Otherwise, the EC2 API might not behave as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway\n volumes are changing to a longer format. Starting in December 2016, all new volumes and\n snapshots will be created with a 17-character string. Starting in April 2016, you will\n be able to use these longer IDs so you can test your systems with the new format. For\n more information, see Longer EC2 and\n EBS resource IDs.
\nFor example, a volume Amazon Resource Name (ARN) with the longer volume ID format\n looks like the following:
\n\n arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following:\n snap-78e226633445566ee.
For more information, see Announcement:\n Heads-up \u2013 Longer Storage Gateway volume and snapshot IDs coming in\n 2016.
\nThe Amazon Resource Name (ARN) of the storage volume.
" } }, "VolumeId": { "target": "com.amazonaws.storagegateway#VolumeId", "traits": { "smithy.api#documentation": "The unique identifier of the volume, e.g., vol-AE4B946D.
" } }, "VolumeType": { "target": "com.amazonaws.storagegateway#VolumeType", "traits": { "smithy.api#documentation": "One of the VolumeType enumeration values describing the type of the volume.
" } }, "VolumeStatus": { "target": "com.amazonaws.storagegateway#VolumeStatus", "traits": { "smithy.api#documentation": "One of the VolumeStatus values that indicates the state of the storage volume.
" } }, "VolumeAttachmentStatus": { "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", "traits": { "smithy.api#documentation": "A value that indicates whether a storage volume is attached to, detached from, or is in\n the process of detaching from a gateway. For more information, see Moving\n your volumes to a different gateway.
" } }, "VolumeSizeInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The size of the volume in bytes.
" } }, "VolumeProgress": { "target": "com.amazonaws.storagegateway#DoubleObject", "traits": { "smithy.api#documentation": "Represents the percentage complete if the volume is restoring or bootstrapping that\n represents the percent of data transferred. This field does not appear in the response if\n the stored volume is not restoring or bootstrapping.
" } }, "VolumeDiskId": { "target": "com.amazonaws.storagegateway#DiskId", "traits": { "smithy.api#documentation": "The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
" } }, "SourceSnapshotId": { "target": "com.amazonaws.storagegateway#SnapshotId", "traits": { "smithy.api#documentation": "If the stored volume was created from a snapshot, this field contains the snapshot ID\n used, e.g. snap-78e22663. Otherwise, this field is not included.
" } }, "PreservedExistingData": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Indicates if when the stored volume was created, existing data on the underlying local\n disk was preserved.
\nValid Values: true | false\n
An VolumeiSCSIAttributes object that represents a collection of iSCSI\n attributes for one stored volume.
" } }, "CreatedDate": { "target": "com.amazonaws.storagegateway#CreatedDate", "traits": { "smithy.api#documentation": "The date the volume was created. Volumes created prior to March 28, 2017 don\u2019t have this\n timestamp.
" } }, "VolumeUsedInBytes": { "target": "com.amazonaws.storagegateway#VolumeUsedInBytes", "traits": { "smithy.api#documentation": "The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.
\nThe name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
" } } }, "traits": { "smithy.api#documentation": "Describes an iSCSI stored volume.
" } }, "com.amazonaws.storagegateway#StorediSCSIVolumes": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#StorediSCSIVolume" } }, "com.amazonaws.storagegateway#SupportedGatewayCapacities": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#GatewayCapacity" } }, "com.amazonaws.storagegateway#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.storagegateway#TagKey", "traits": { "smithy.api#documentation": "Tag key. The key can't start with aws:.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.storagegateway#TagValue", "traits": { "smithy.api#documentation": "Value of the tag key.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A key-value pair that helps you manage, filter, and search for your resource. Allowed\n characters: letters, white space, and numbers, representable in UTF-8, and the following\n characters: + - = . _ : /.
" } }, "com.amazonaws.storagegateway#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.storagegateway#TagKeys": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#TagKey" } }, "com.amazonaws.storagegateway#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.storagegateway#Tags": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#Tag" } }, "com.amazonaws.storagegateway#Tape": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape.
" } }, "TapeBarcode": { "target": "com.amazonaws.storagegateway#TapeBarcode", "traits": { "smithy.api#documentation": "The barcode that identifies a specific virtual tape.
" } }, "TapeCreatedDate": { "target": "com.amazonaws.storagegateway#Time", "traits": { "smithy.api#documentation": "The date the virtual tape was created.
" } }, "TapeSizeInBytes": { "target": "com.amazonaws.storagegateway#TapeSize", "traits": { "smithy.api#documentation": "The size, in bytes, of the virtual tape capacity.
" } }, "TapeStatus": { "target": "com.amazonaws.storagegateway#TapeStatus", "traits": { "smithy.api#documentation": "The current state of the virtual tape.
" } }, "VTLDevice": { "target": "com.amazonaws.storagegateway#VTLDeviceARN", "traits": { "smithy.api#documentation": "The virtual tape library (VTL) device that the virtual tape is associated with.
" } }, "Progress": { "target": "com.amazonaws.storagegateway#DoubleObject", "traits": { "smithy.api#documentation": "For archiving virtual tapes, indicates how much data remains to be uploaded before\n archiving is complete.
\nRange: 0 (not started) to 100 (complete).
" } }, "TapeUsedInBytes": { "target": "com.amazonaws.storagegateway#TapeUsage", "traits": { "smithy.api#documentation": "The size, in bytes, of data stored on the virtual tape.
\nThis value is not available for tapes created prior to May 13, 2015.
\nThe ID of the pool that contains tapes that will be archived. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
" } }, "Worm": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "If the tape is archived as write-once-read-many (WORM), this value is\n true.
The date that the tape is first archived with tape retention lock enabled.
" } }, "PoolEntryDate": { "target": "com.amazonaws.storagegateway#Time", "traits": { "smithy.api#documentation": "The date that the tape enters a custom tape pool.
" } } }, "traits": { "smithy.api#documentation": "Describes a virtual tape object.
" } }, "com.amazonaws.storagegateway#TapeARN": { "type": "string", "traits": { "smithy.api#length": { "min": 50, "max": 500 }, "smithy.api#pattern": "^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*|-eusc)):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{5,16}$" } }, "com.amazonaws.storagegateway#TapeARNs": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#TapeARN" }, "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't\n specify a tape ARN, the response lists all tapes in both your VTL and VTS.
" } }, "com.amazonaws.storagegateway#TapeArchive": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an archived virtual tape.
" } }, "TapeBarcode": { "target": "com.amazonaws.storagegateway#TapeBarcode", "traits": { "smithy.api#documentation": "The barcode that identifies the archived virtual tape.
" } }, "TapeCreatedDate": { "target": "com.amazonaws.storagegateway#Time", "traits": { "smithy.api#documentation": "The date the virtual tape was created.
" } }, "TapeSizeInBytes": { "target": "com.amazonaws.storagegateway#TapeSize", "traits": { "smithy.api#documentation": "The size, in bytes, of the archived virtual tape.
" } }, "CompletionTime": { "target": "com.amazonaws.storagegateway#Time", "traits": { "smithy.api#documentation": "The time that the archiving of the virtual tape was completed.
\nThe default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'\n format.
" } }, "RetrievedTo": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being\n retrieved to.
\nThe virtual tape is retrieved from the virtual tape shelf (VTS).
" } }, "TapeStatus": { "target": "com.amazonaws.storagegateway#TapeArchiveStatus", "traits": { "smithy.api#documentation": "The current state of the archived virtual tape.
" } }, "TapeUsedInBytes": { "target": "com.amazonaws.storagegateway#TapeUsage", "traits": { "smithy.api#documentation": "The size, in bytes, of data stored on the virtual tape.
\nThis value is not available for tapes created prior to May 13, 2015.
\nThe ID of the pool that was used to archive the tape. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool.
" } }, "Worm": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Set to true if the archived tape is stored as write-once-read-many\n (WORM).
If the archived tape is subject to tape retention lock, the date that the archived tape\n started being retained.
" } }, "PoolEntryDate": { "target": "com.amazonaws.storagegateway#Time", "traits": { "smithy.api#documentation": "The time that the tape entered the custom tape pool.
\nThe default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'\n format.
" } } }, "traits": { "smithy.api#documentation": "Represents a virtual tape that is archived in the virtual tape shelf (VTS).
" } }, "com.amazonaws.storagegateway#TapeArchiveStatus": { "type": "string" }, "com.amazonaws.storagegateway#TapeArchives": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#TapeArchive" } }, "com.amazonaws.storagegateway#TapeBarcode": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 16 }, "smithy.api#pattern": "^[A-Z0-9]*$" } }, "com.amazonaws.storagegateway#TapeBarcodePrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4 }, "smithy.api#pattern": "^[A-Z]*$" } }, "com.amazonaws.storagegateway#TapeDriveType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 50 } } }, "com.amazonaws.storagegateway#TapeInfo": { "type": "structure", "members": { "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a virtual tape.
" } }, "TapeBarcode": { "target": "com.amazonaws.storagegateway#TapeBarcode", "traits": { "smithy.api#documentation": "The barcode that identifies a specific virtual tape.
" } }, "TapeSizeInBytes": { "target": "com.amazonaws.storagegateway#TapeSize", "traits": { "smithy.api#documentation": "The size, in bytes, of a virtual tape.
" } }, "TapeStatus": { "target": "com.amazonaws.storagegateway#TapeStatus", "traits": { "smithy.api#documentation": "The status of the tape.
" } }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Amazon Web Services Region.
" } }, "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { "smithy.api#documentation": "The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
" } }, "RetentionStartDate": { "target": "com.amazonaws.storagegateway#Time", "traits": { "smithy.api#documentation": "The date that the tape became subject to tape retention lock.
" } }, "PoolEntryDate": { "target": "com.amazonaws.storagegateway#Time", "traits": { "smithy.api#documentation": "The date that the tape entered the custom tape pool with tape retention lock\n enabled.
" } } }, "traits": { "smithy.api#documentation": "Describes a virtual tape.
" } }, "com.amazonaws.storagegateway#TapeInfos": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#TapeInfo" }, "traits": { "smithy.api#documentation": "An array of TapeInfo objects, where each object describes a single\n tape. If there are no tapes in the tape library or VTS, then the TapeInfos is\n an empty array.
The Amazon Resource Name (ARN) of the virtual tape.
" } }, "TapeRecoveryPointTime": { "target": "com.amazonaws.storagegateway#Time", "traits": { "smithy.api#documentation": "The time when the point-in-time view of the virtual tape was replicated for later\n recovery.
\nThe default timestamp format of the tape recovery point time is in the ISO8601 extended\n YYYY-MM-DD'T'HH:MM:SS'Z' format.
" } }, "TapeSizeInBytes": { "target": "com.amazonaws.storagegateway#TapeSize", "traits": { "smithy.api#documentation": "The size, in bytes, of the virtual tapes to recover.
" } }, "TapeStatus": { "target": "com.amazonaws.storagegateway#TapeRecoveryPointStatus", "traits": { "smithy.api#documentation": "The status of the virtual tapes.
" } } }, "traits": { "smithy.api#documentation": "Describes a recovery point.
" } }, "com.amazonaws.storagegateway#TapeRecoveryPointInfos": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#TapeRecoveryPointInfo" } }, "com.amazonaws.storagegateway#TapeRecoveryPointStatus": { "type": "string" }, "com.amazonaws.storagegateway#TapeSize": { "type": "long" }, "com.amazonaws.storagegateway#TapeStatus": { "type": "string" }, "com.amazonaws.storagegateway#TapeStorageClass": { "type": "enum", "members": { "DEEP_ARCHIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEEP_ARCHIVE" } }, "GLACIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GLACIER" } } } }, "com.amazonaws.storagegateway#TapeUsage": { "type": "long" }, "com.amazonaws.storagegateway#Tapes": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#Tape" } }, "com.amazonaws.storagegateway#TargetARN": { "type": "string", "traits": { "smithy.api#length": { "min": 50, "max": 800 } } }, "com.amazonaws.storagegateway#TargetName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 200 }, "smithy.api#pattern": "^[-\\.;a-z0-9]+$" } }, "com.amazonaws.storagegateway#Time": { "type": "timestamp" }, "com.amazonaws.storagegateway#TimeoutInSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 3600 } } }, "com.amazonaws.storagegateway#UpdateAutomaticTapeCreationPolicy": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateAutomaticTapeCreationPolicyInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateAutomaticTapeCreationPolicyOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates the automatic tape creation policy of a gateway. Use this to update the policy\n with a new set of automatic tape creation rules. This is only supported for tape\n gateways.
\nBy default, there is no automatic tape creation policy.
\nA gateway can have only one automatic tape creation policy.
\nAn automatic tape creation policy consists of a list of automatic tape creation rules.\n The rules determine when and how to automatically create new tapes.
", "smithy.api#required": {} } }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#UpdateAutomaticTapeCreationPolicyOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateBandwidthRateLimit": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateBandwidthRateLimitInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateBandwidthRateLimitOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates the bandwidth rate limits of a gateway. You can update both the upload and\n download bandwidth rate limit or specify only one of the two. If you don't set a\n bandwidth rate limit, the existing rate limit remains. This operation is supported only for\n the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits\n for S3 file gateways, use UpdateBandwidthRateLimitSchedule.
\nBy default, a gateway's bandwidth rate limits are not set. If you don't set\n any limit, the gateway does not have any limitations on its bandwidth usage and could\n potentially use the maximum available bandwidth.
\nTo specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in\n your request.
", "smithy.api#examples": [ { "title": "To update the bandwidth rate limits of a gateway", "documentation": "Updates the bandwidth rate limits of a gateway. Both the upload and download bandwidth rate limit can be set, or either one of the two. If a new limit is not set, the existing rate limit remains.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "AverageUploadRateLimitInBitsPerSec": 51200, "AverageDownloadRateLimitInBitsPerSec": 102400 }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" } } ] } }, "com.amazonaws.storagegateway#UpdateBandwidthRateLimitInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "AverageUploadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthUploadRateLimit", "traits": { "smithy.api#documentation": "The average upload bandwidth rate limit in bits per second.
" } }, "AverageDownloadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", "traits": { "smithy.api#documentation": "The average download bandwidth rate limit in bits per second.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing one or more of the following fields:
\n\n UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec\n
\n\n UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec\n
\nA JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle\n information was updated.
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateBandwidthRateLimitSchedule": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateBandwidthRateLimitScheduleInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateBandwidthRateLimitScheduleOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways\n do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in\n effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This\n operation is supported for volume, tape, and S3 file gateways. S3 file gateways support\n bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate\n limits.
" } }, "com.amazonaws.storagegateway#UpdateBandwidthRateLimitScheduleInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "BandwidthRateLimitIntervals": { "target": "com.amazonaws.storagegateway#BandwidthRateLimitIntervals", "traits": { "smithy.api#documentation": "An array containing bandwidth rate limit schedule intervals for a gateway. When no\n bandwidth rate limit intervals have been scheduled, the array is empty.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#UpdateBandwidthRateLimitScheduleOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateChapCredentials": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateChapCredentialsInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateChapCredentialsOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a\n specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for\n added security, you might use it. This operation is supported in the volume and tape\n gateway types.
\nWhen you update CHAP credentials, all existing connections on the target are closed\n and initiators must reconnect with the new credentials.
\nThe Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified\n VolumeARN.
", "smithy.api#required": {} } }, "SecretToAuthenticateInitiator": { "target": "com.amazonaws.storagegateway#ChapSecret", "traits": { "smithy.api#documentation": "The secret key that the initiator (for example, the Windows client) must provide to\n participate in mutual CHAP with the target.
\nThe secret key must be between 12 and 16 bytes when encoded in UTF-8.
\nThe iSCSI initiator that connects to the target.
", "smithy.api#required": {} } }, "SecretToAuthenticateTarget": { "target": "com.amazonaws.storagegateway#ChapSecret", "traits": { "smithy.api#documentation": "The secret key that the target must provide to participate in mutual CHAP with the\n initiator (e.g. Windows client).
\nByte constraints: Minimum bytes of 12. Maximum bytes of 16.
\nThe secret key must be between 12 and 16 bytes when encoded in UTF-8.
\nA JSON object containing one or more of the following fields:
\n\n UpdateChapCredentialsInput$SecretToAuthenticateInitiator\n
\nThe Amazon Resource Name (ARN) of the target. This is the same target specified in the\n request.
" } }, "InitiatorName": { "target": "com.amazonaws.storagegateway#IqnName", "traits": { "smithy.api#documentation": "The iSCSI initiator that connects to the target. This is the same initiator name\n specified in the request.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing the following fields:
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateFileSystemAssociation": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateFileSystemAssociationInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateFileSystemAssociationOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates a file system association. This operation is only supported in the FSx File\n Gateways.
" } }, "com.amazonaws.storagegateway#UpdateFileSystemAssociationInput": { "type": "structure", "members": { "FileSystemAssociationARN": { "target": "com.amazonaws.storagegateway#FileSystemAssociationARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file system association that you want to\n update.
", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.storagegateway#DomainUserName", "traits": { "smithy.api#documentation": "The user name of the user credential that has permission to access the root share D$ of\n the Amazon FSx file system. The user account must belong to the Amazon FSx\n delegated admin user group.
" } }, "Password": { "target": "com.amazonaws.storagegateway#DomainUserPassword", "traits": { "smithy.api#documentation": "The password of the user credential.
" } }, "AuditDestinationARN": { "target": "com.amazonaws.storagegateway#AuditDestinationARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the storage used for the audit logs.
" } }, "CacheAttributes": { "target": "com.amazonaws.storagegateway#CacheAttributes" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#UpdateFileSystemAssociationOutput": { "type": "structure", "members": { "FileSystemAssociationARN": { "target": "com.amazonaws.storagegateway#FileSystemAssociationARN", "traits": { "smithy.api#documentation": "The ARN of the updated file system association.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateGatewayInformation": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateGatewayInformationInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateGatewayInformationOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates a gateway's metadata, which includes the gateway's name, time zone,\n and metadata cache size. To specify which gateway to update, use the Amazon Resource Name\n (ARN) of the gateway in your request.
\nFor gateways activated after September 2, 2015, the gateway's ARN contains the\n gateway ID rather than the gateway name. However, changing the name of the gateway has\n no effect on the gateway's ARN.
\nA value that indicates the time zone of the gateway.
" } }, "CloudWatchLogGroupARN": { "target": "com.amazonaws.storagegateway#CloudWatchLogGroupARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use\n to monitor and log events in the gateway.
\nFor more information, see What is Amazon CloudWatch\n Logs?\n
" } }, "GatewayCapacity": { "target": "com.amazonaws.storagegateway#GatewayCapacity", "traits": { "smithy.api#documentation": "Specifies the size of the gateway's metadata cache. This setting impacts gateway\n performance and hardware recommendations. For more information, see Performance guidance for gateways with multiple file shares\n in the Amazon S3 File Gateway User Guide.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#UpdateGatewayInformationOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "GatewayName": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "The name you configured for your gateway.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the gateway that was\n updated.
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateGatewaySoftwareNow": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateGatewaySoftwareNowInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateGatewaySoftwareNowOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates the gateway virtual machine (VM) software. The request immediately triggers the\n software update.
\nWhen you make this request, you get a 200 OK success response\n immediately. However, it might take some time for the update to complete. You can call\n DescribeGatewayInformation to verify the gateway is in the\n STATE_RUNNING state.
A software update forces a system restart of your gateway. You can minimize the\n chance of any disruption to your applications by increasing your iSCSI Initiators'\n timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and\n Linux, see Customizing your Windows iSCSI settings and Customizing your Linux iSCSI settings, respectively.
\nA JSON object containing the Amazon Resource Name (ARN) of the gateway to update.
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#UpdateGatewaySoftwareNowOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the gateway that was\n updated.
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateMaintenanceStartTime": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateMaintenanceStartTimeInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateMaintenanceStartTimeOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates a gateway's maintenance window schedule, with settings for monthly or\n weekly cadence, specific day and time to begin maintenance, and which types of updates to\n apply. Time configuration uses the gateway's time zone. You can pass values for a complete\n maintenance schedule, or update policy, or both. Previous values will persist for whichever\n setting you choose not to modify. If an incomplete or invalid maintenance schedule is\n passed, the entire request will be rejected with an error and no changes will occur.
\nA complete maintenance schedule must include values for both\n MinuteOfHour and HourOfDay, and either\n DayOfMonth\n or\n DayOfWeek.
We recommend keeping maintenance updates turned on, except in specific use cases\n where the brief disruptions caused by updating the gateway could critically impact your\n deployment.
\nThe hour component of the maintenance start time represented as hh,\n where hh is the hour (00 to 23). The hour of the day is in the time\n zone of the gateway.
" } }, "MinuteOfHour": { "target": "com.amazonaws.storagegateway#MinuteOfHour", "traits": { "smithy.api#documentation": "The minute component of the maintenance start time represented as\n mm, where mm is the minute (00 to 59). The\n minute of the hour is in the time zone of the gateway.
" } }, "DayOfWeek": { "target": "com.amazonaws.storagegateway#DayOfWeek", "traits": { "smithy.api#documentation": "The day of the week component of the maintenance start time week represented as an\n ordinal number from 0 to 6, where 0 represents Sunday and 6 represents Saturday.
" } }, "DayOfMonth": { "target": "com.amazonaws.storagegateway#DayOfMonth", "traits": { "smithy.api#documentation": "The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month. It is not possible to\n set the maintenance schedule to start on days 29 through 31.
" } }, "SoftwareUpdatePreferences": { "target": "com.amazonaws.storagegateway#SoftwareUpdatePreferences", "traits": { "smithy.api#documentation": "A set of variables indicating the software update preferences for the gateway.
\nIncludes AutomaticUpdatePolicy field with the following inputs:
\n ALL_VERSIONS - Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The\n gateway will still receive emergency version updates on rare occasions if necessary to\n remedy highly critical security or durability issues. You will be notified before an\n emergency version update is applied. These updates are applied during your gateway's\n scheduled maintenance window.
A JSON object containing the following fields:
\n\n UpdateMaintenanceStartTimeInput$SoftwareUpdatePreferences\n
\nA JSON object containing the Amazon Resource Name (ARN) of the gateway whose maintenance\n start time is updated.
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateNFSFileShare": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateNFSFileShareInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateNFSFileShareOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates a Network File System (NFS) file share. This operation is only supported in S3\n File Gateways.
\nTo leave a file share field unchanged, set the corresponding input field to\n null.
\nUpdates the following file share settings:
\nDefault storage class for your S3 bucket
\nMetadata defaults for your S3 bucket
\nAllowed NFS clients for your file share
\nSquash settings
\nWrite status of your file share
\nThe Amazon Resource Name (ARN) of the file share to be updated.
", "smithy.api#required": {} } }, "EncryptionType": { "target": "com.amazonaws.storagegateway#EncryptionType", "traits": { "smithy.api#documentation": "A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used\n for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric\n CMKs. This value must be set if KMSEncrypted is true, or if\n EncryptionType is SseKms or DsseKms.
The default values for the file share. Optional.
" } }, "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { "smithy.api#documentation": "The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a S3 File Gateway puts objects into. The default value is private.
The list of clients that are allowed to access the S3 File Gateway. The list must\n contain either valid IPv4/IPv6 addresses or valid CIDR blocks.
" } }, "Squash": { "target": "com.amazonaws.storagegateway#Squash", "traits": { "smithy.api#documentation": "The user mapped to anonymous user.
\nValid values are the following:
\n\n RootSquash: Only root is mapped to anonymous user.
\n NoSquash: No one is mapped to anonymous user.
\n AllSquash: Everyone is mapped to anonymous user.
A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.
Valid Values: true | false\n
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.
Valid Values: true | false\n
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true | false\n
The name of the file share. Optional.
\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
A valid NFS file share name can only contain the following characters:\n a-z, A-Z,\n 0-9, -, ., and\n _.
Specifies refresh cache information for the file share.
" } }, "NotificationPolicy": { "target": "com.amazonaws.storagegateway#NotificationPolicy", "traits": { "smithy.api#documentation": "The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
The Amazon Resource Name (ARN) of the storage used for audit logs.
" } } }, "traits": { "smithy.api#documentation": "UpdateNFSFileShareInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#UpdateNFSFileShareOutput": { "type": "structure", "members": { "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated file share.
" } } }, "traits": { "smithy.api#documentation": "UpdateNFSFileShareOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateSMBFileShare": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateSMBFileShareInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateSMBFileShareOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates a Server Message Block (SMB) file share. This operation is only supported for S3\n File Gateways.
\nTo leave a file share field unchanged, set the corresponding input field to\n null.
\nFile gateways require Security Token Service (Amazon Web Services STS) to be\n activated to enable you to create a file share. Make sure that Amazon Web Services STS\n is activated in the Amazon Web Services Region you are creating your file gateway in. If\n Amazon Web Services STS is not activated in this Amazon Web Services Region, activate\n it. For information about how to activate Amazon Web Services STS, see Activating and\n deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Identity and Access Management User Guide.
\nFile gateways don't support creating hard or symbolic links on a file\n share.
\nThe Amazon Resource Name (ARN) of the SMB file share that you want to update.
", "smithy.api#required": {} } }, "EncryptionType": { "target": "com.amazonaws.storagegateway#EncryptionType", "traits": { "smithy.api#documentation": "A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used\n for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric\n CMKs. This value must be set if KMSEncrypted is true, or if\n EncryptionType is SseKms or DsseKms.
The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a S3 File Gateway puts objects into. The default value is private.
A value that sets the write status of a file share. Set this value to true\n to set write status to read-only, otherwise set to false.
Valid Values: true | false\n
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.
Valid Values: true | false\n
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true | false\n
Set this value to true to enable access control list (ACL) on the SMB file\n share. Set it to false to map file and directory permissions to the POSIX\n permissions.
For more information, see Using Windows ACLs to limit SMB file share\n access in the Amazon S3 File Gateway User\n Guide.
\nValid Values: true | false\n
The files and folders on this share will only be visible to users with read\n access.
" } }, "AdminUserList": { "target": "com.amazonaws.storagegateway#UserList", "traits": { "smithy.api#documentation": "A list of users or groups in the Active Directory that have administrator rights to the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.
A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.
A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.
The Amazon Resource Name (ARN) of the storage used for audit logs.
" } }, "CaseSensitivity": { "target": "com.amazonaws.storagegateway#CaseSensitivity", "traits": { "smithy.api#documentation": "The case of an object name in an Amazon S3 bucket. For\n ClientSpecified, the client determines the case sensitivity. For\n CaseSensitive, the gateway determines the case sensitivity. The default\n value is ClientSpecified.
The name of the file share. Optional.
\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
A valid SMB file share name cannot contain the following characters:\n [,],#,;,<,>,:,\",\\,/,|,?,*,+,\n or ASCII control characters 1-31.
Specifies refresh cache information for the file share.
" } }, "NotificationPolicy": { "target": "com.amazonaws.storagegateway#NotificationPolicy", "traits": { "smithy.api#documentation": "The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
Specifies whether opportunistic locking is enabled for the SMB file share.
\nEnabling opportunistic locking on case-sensitive shares is not recommended for\n workloads that involve access to files with the same name in different case.
\nValid Values: true | false\n
UpdateSMBFileShareInput
", "smithy.api#input": {} } }, "com.amazonaws.storagegateway#UpdateSMBFileShareOutput": { "type": "structure", "members": { "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated SMB file share.
" } } }, "traits": { "smithy.api#documentation": "UpdateSMBFileShareOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateSMBFileShareVisibility": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateSMBFileShareVisibilityInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateSMBFileShareVisibilityOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Controls whether the shares on an S3 File Gateway are visible in a net view or browse\n list. The operation is only supported for S3 File Gateways.
" } }, "com.amazonaws.storagegateway#UpdateSMBFileShareVisibilityInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "FileSharesVisible": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { "smithy.api#documentation": "The shares on this gateway appear when listing shares.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#UpdateSMBFileShareVisibilityOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateSMBLocalGroups": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateSMBLocalGroupsInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateSMBLocalGroupsOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates the list of Active Directory users and groups that have special permissions for\n SMB file shares on the gateway.
" } }, "com.amazonaws.storagegateway#UpdateSMBLocalGroupsInput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#required": {} } }, "SMBLocalGroups": { "target": "com.amazonaws.storagegateway#SMBLocalGroups", "traits": { "smithy.api#documentation": "A list of Active Directory users and groups that you want to grant special permissions\n for SMB file shares on the gateway.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.storagegateway#UpdateSMBLocalGroupsOutput": { "type": "structure", "members": { "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateSMBSecurityStrategy": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateSMBSecurityStrategyInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateSMBSecurityStrategyOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates the SMB security strategy level for an Amazon S3 file gateway. This\n action is only supported for Amazon S3 file gateways.
\nFor information about configuring this setting using the Amazon Web Services console,\n see Setting a security level for your gateway in the Amazon S3\n File Gateway User Guide.
\nA higher security strategy level can affect performance of the gateway.
\nSpecifies the type of security strategy.
\n\n ClientSpecified: If you choose this option, requests are established based\n on what is negotiated by the client. This option is recommended when you want to maximize\n compatibility across different clients in your environment. Supported only for S3 File\n Gateway.
\n MandatorySigning: If you choose this option, File Gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with\n SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
\n MandatoryEncryption: If you choose this option, File Gateway only allows\n connections from SMBv3 clients that have encryption enabled. This option is recommended for\n environments that handle sensitive data. This option works with SMB clients on Microsoft\n Windows 8, Windows Server 2012 or newer.
\n MandatoryEncryptionNoAes128: If you choose this option, File Gateway only\n allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit\n algorithms are not allowed. This option is recommended for environments that handle\n sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or\n later.
Updates a snapshot schedule configured for a gateway volume. This operation is only\n supported in the cached volume and stored volume gateway types.
\nThe default snapshot schedule for volume is once every 24 hours, starting at the\n creation time of the volume. You can use this API to change the snapshot schedule\n configured for the volume.
\nIn the request you must identify the gateway volume whose snapshot schedule you want to\n update, and the schedule information, including when you want the snapshot to begin on a\n day and the frequency (in hours) of snapshots.
", "smithy.api#examples": [ { "title": "To update a volume snapshot schedule", "documentation": "Updates a snapshot schedule configured for a gateway volume.", "input": { "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", "StartAt": 0, "RecurrenceInHours": 1, "Description": "Hourly snapshot" }, "output": { "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" } } ] } }, "com.amazonaws.storagegateway#UpdateSnapshotScheduleInput": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume. Use the ListVolumes\n operation to return a list of gateway volumes.
", "smithy.api#required": {} } }, "StartAt": { "target": "com.amazonaws.storagegateway#HourOfDay", "traits": { "smithy.api#documentation": "The hour of the day at which the snapshot schedule begins represented as\n hh, where hh is the hour (0 to 23). The hour\n of the day is in the time zone of the gateway.
", "smithy.api#required": {} } }, "RecurrenceInHours": { "target": "com.amazonaws.storagegateway#RecurrenceInHours", "traits": { "smithy.api#documentation": "Frequency of snapshots. Specify the number of hours between snapshots.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.storagegateway#Description", "traits": { "smithy.api#documentation": "Optional description of the snapshot that overwrites the existing description.
" } }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { "smithy.api#documentation": "A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.
\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nA JSON object containing one or more of the following fields:
\nThe Amazon Resource Name (ARN) of the volume. Use the ListVolumes\n operation to return a list of gateway volumes.
" } } }, "traits": { "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the updated storage\n volume.
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UpdateVTLDeviceType": { "type": "operation", "input": { "target": "com.amazonaws.storagegateway#UpdateVTLDeviceTypeInput" }, "output": { "target": "com.amazonaws.storagegateway#UpdateVTLDeviceTypeOutput" }, "errors": [ { "target": "com.amazonaws.storagegateway#InternalServerError" }, { "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" } ], "traits": { "smithy.api#documentation": "Updates the type of medium changer in a tape gateway. When you activate a tape gateway,\n you select a medium changer type for the tape gateway. This operation enables you to select\n a different type of medium changer after a tape gateway is activated. This operation is\n only supported in the tape gateway type.
", "smithy.api#examples": [ { "title": "To update a VTL device type", "documentation": "Updates the type of medium changer in a gateway-VTL after a gateway-VTL is activated.", "input": { "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001", "DeviceType": "Medium Changer" }, "output": { "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001" } } ] } }, "com.amazonaws.storagegateway#UpdateVTLDeviceTypeInput": { "type": "structure", "members": { "VTLDeviceARN": { "target": "com.amazonaws.storagegateway#VTLDeviceARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the medium changer you want to select.
", "smithy.api#required": {} } }, "DeviceType": { "target": "com.amazonaws.storagegateway#DeviceType", "traits": { "smithy.api#documentation": "The type of medium changer you want to select.
\nValid Values: STK-L700 | AWS-Gateway-VTL |\n IBM-03584L32-0402\n
The Amazon Resource Name (ARN) of the medium changer you have selected.
" } } }, "traits": { "smithy.api#documentation": "UpdateVTLDeviceTypeOutput
", "smithy.api#output": {} } }, "com.amazonaws.storagegateway#UserList": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#UserListUser" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.storagegateway#UserListUser": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.storagegateway#VTLDevice": { "type": "structure", "members": { "VTLDeviceARN": { "target": "com.amazonaws.storagegateway#VTLDeviceARN", "traits": { "smithy.api#documentation": "Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media\n changer).
" } }, "VTLDeviceType": { "target": "com.amazonaws.storagegateway#VTLDeviceType", "traits": { "smithy.api#documentation": "Specifies the type of device that the VTL device emulates.
" } }, "VTLDeviceVendor": { "target": "com.amazonaws.storagegateway#VTLDeviceVendor", "traits": { "smithy.api#documentation": "Specifies the vendor of the device that the VTL device object emulates.
" } }, "VTLDeviceProductIdentifier": { "target": "com.amazonaws.storagegateway#VTLDeviceProductIdentifier", "traits": { "smithy.api#documentation": "Specifies the model number of device that the VTL device emulates.
" } }, "DeviceiSCSIAttributes": { "target": "com.amazonaws.storagegateway#DeviceiSCSIAttributes", "traits": { "smithy.api#documentation": "A list of iSCSI information about a VTL device.
" } } }, "traits": { "smithy.api#documentation": "Represents a device object associated with a tape gateway.
" } }, "com.amazonaws.storagegateway#VTLDeviceARN": { "type": "string", "traits": { "smithy.api#length": { "min": 50, "max": 500 } } }, "com.amazonaws.storagegateway#VTLDeviceARNs": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#VTLDeviceARN" } }, "com.amazonaws.storagegateway#VTLDeviceProductIdentifier": { "type": "string" }, "com.amazonaws.storagegateway#VTLDeviceType": { "type": "string" }, "com.amazonaws.storagegateway#VTLDeviceVendor": { "type": "string" }, "com.amazonaws.storagegateway#VTLDevices": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#VTLDevice" } }, "com.amazonaws.storagegateway#VolumeARN": { "type": "string", "traits": { "smithy.api#length": { "min": 50, "max": 500 }, "smithy.api#pattern": "^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*|-eusc)):storagegateway:[a-z\\-0-9]+:[0-9]+:gateway\\/(.+)\\/volume\\/vol-(\\S+)$" } }, "com.amazonaws.storagegateway#VolumeARNs": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#VolumeARN" } }, "com.amazonaws.storagegateway#VolumeAttachmentStatus": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 50 } } }, "com.amazonaws.storagegateway#VolumeId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 30 } } }, "com.amazonaws.storagegateway#VolumeInfo": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the storage volume. For example, the following is a\n valid ARN:
\n\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB\n
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" } }, "VolumeId": { "target": "com.amazonaws.storagegateway#VolumeId", "traits": { "smithy.api#documentation": "The unique identifier assigned to the volume. This ID becomes part of the volume Amazon\n Resource Name (ARN), which you use as input for other operations.
\nValid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" } }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "GatewayId": { "target": "com.amazonaws.storagegateway#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.
\nValid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" } }, "VolumeType": { "target": "com.amazonaws.storagegateway#VolumeType", "traits": { "smithy.api#documentation": "One of the VolumeType enumeration values describing the type of the volume.
" } }, "VolumeSizeInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The size of the volume in bytes.
\nValid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" } }, "VolumeAttachmentStatus": { "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", "traits": { "smithy.api#documentation": "One of the VolumeStatus values that indicates the state of the storage volume.
" } } }, "traits": { "smithy.api#documentation": "Describes a storage volume object.
" } }, "com.amazonaws.storagegateway#VolumeInfos": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#VolumeInfo" } }, "com.amazonaws.storagegateway#VolumeRecoveryPointInfo": { "type": "structure", "members": { "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume target.
" } }, "VolumeSizeInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The size of the volume in bytes.
" } }, "VolumeUsageInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The size of the data stored on the volume in bytes.
\nThis value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.
\nThe time the recovery point was taken.
" } } }, "traits": { "smithy.api#documentation": "Describes a storage volume recovery point object.
" } }, "com.amazonaws.storagegateway#VolumeRecoveryPointInfos": { "type": "list", "member": { "target": "com.amazonaws.storagegateway#VolumeRecoveryPointInfo" } }, "com.amazonaws.storagegateway#VolumeStatus": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 50 } } }, "com.amazonaws.storagegateway#VolumeType": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 100 } } }, "com.amazonaws.storagegateway#VolumeUsedInBytes": { "type": "long" }, "com.amazonaws.storagegateway#VolumeiSCSIAttributes": { "type": "structure", "members": { "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume target.
" } }, "NetworkInterfaceId": { "target": "com.amazonaws.storagegateway#NetworkInterfaceId", "traits": { "smithy.api#documentation": "The network interface identifier.
" } }, "NetworkInterfacePort": { "target": "com.amazonaws.storagegateway#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The port used to communicate with iSCSI targets.
" } }, "LunNumber": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { "smithy.api#documentation": "The logical disk number.
" } }, "ChapEnabled": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Indicates whether mutual CHAP is enabled for the iSCSI target.
" } } }, "traits": { "smithy.api#documentation": "Lists iSCSI information about a volume.
" } }, "com.amazonaws.storagegateway#double": { "type": "double", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.storagegateway#errorDetails": { "type": "map", "key": { "target": "com.amazonaws.storagegateway#string" }, "value": { "target": "com.amazonaws.storagegateway#string" } }, "com.amazonaws.storagegateway#integer": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.storagegateway#long": { "type": "long", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.storagegateway#string": { "type": "string" } } }