Struct aws_sdk_storagegateway::Client

pub struct Client { /* private fields */ }

Client for AWS Storage Gateway

Client for invoking operations on AWS Storage Gateway. Each operation on AWS Storage Gateway is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_storagegateway::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_storagegateway::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the ActivateGateway operation has a Client::activate_gateway, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.activate_gateway()
    .activation_key("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn activate_gateway(&self) -> ActivateGatewayFluentBuilder

Constructs a fluent builder for the ActivateGateway operation.

• The fluent builder is configurable:
  • activation_key(impl Into<String>) / set_activation_key(Option<String>):
    required: true
    

    Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults – the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

    For more information, see Getting activation key in the Storage Gateway User Guide.

    
    
  • gateway_name(impl Into<String>) / set_gateway_name(Option<String>):
    required: true
    

    The name you configured for your gateway.

    
    
  • gateway_timezone(impl Into<String>) / set_gateway_timezone(Option<String>):
    required: true
    

    A value that indicates the time zone you want to set for the gateway. The time zone is of the format “GMT”, “GMT-hr:mm”, or “GMT+hr:mm”. For example, GMT indicates Greenwich Mean Time without any offset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway’s maintenance schedule.

    
    
  • gateway_region(impl Into<String>) / set_gateway_region(Option<String>):
    required: true
    

    A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your Host header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

    Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

    
    
  • gateway_type(impl Into<String>) / set_gateway_type(Option<String>):
    required: false
    

    A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

    Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB

    
    
  • tape_drive_type(impl Into<String>) / set_tape_drive_type(Option<String>):
    required: false
    

    The value that indicates the type of tape drive to use for tape gateway. This field is optional.

    Valid Values: IBM-ULT3580-TD5

    
    
  • medium_changer_type(impl Into<String>) / set_medium_changer_type(Option<String>):
    required: false
    

    The value that indicates the type of medium changer to use for tape gateway. This field is optional.

    Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256 characters.

    
    
• On success, responds with ActivateGatewayOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<ActivateGatewayError>

impl Client

pub fn add_cache(&self) -> AddCacheFluentBuilder

Constructs a fluent builder for the AddCache operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • disk_ids(impl Into<String>) / set_disk_ids(Option<Vec::<String>>):
    required: true
    

    An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

    
    
• On success, responds with AddCacheOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<AddCacheError>

impl Client

pub fn add_tags_to_resource(&self) -> AddTagsToResourceFluentBuilder

Constructs a fluent builder for the AddTagsToResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource you want to add tags to.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256.

    
    
• On success, responds with AddTagsToResourceOutput with field(s):
  • resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource you want to add tags to.

• On failure, responds with SdkError<AddTagsToResourceError>

impl Client

pub fn add_upload_buffer(&self) -> AddUploadBufferFluentBuilder

Constructs a fluent builder for the AddUploadBuffer operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • disk_ids(impl Into<String>) / set_disk_ids(Option<Vec::<String>>):
    required: true
    

    An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

    
    
• On success, responds with AddUploadBufferOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<AddUploadBufferError>

impl Client

pub fn add_working_storage(&self) -> AddWorkingStorageFluentBuilder

Constructs a fluent builder for the AddWorkingStorage operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • disk_ids(impl Into<String>) / set_disk_ids(Option<Vec::<String>>):
    required: true
    

    An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

    
    
• On success, responds with AddWorkingStorageOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<AddWorkingStorageError>

impl Client

pub fn assign_tape_pool(&self) -> AssignTapePoolFluentBuilder

Constructs a fluent builder for the AssignTapePool operation.

• The fluent builder is configurable:
  • tape_arn(impl Into<String>) / set_tape_arn(Option<String>):
    required: true
    

    The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.

    
    
  • pool_id(impl Into<String>) / set_pool_id(Option<String>):
    required: true
    

    The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    
    
  • bypass_governance_retention(bool) / set_bypass_governance_retention(Option<bool>):
    required: false
    

    Set permissions to bypass governance retention. If the lock type of the archived tape is Governance, the tape’s archived age is not older than RetentionLockInDays, and the user does not already have BypassGovernanceRetention, setting this to TRUE enables the user to bypass the retention lock. This parameter is set to true by default for calls from the console.

    Valid values: TRUE | FALSE

    
    
• On success, responds with AssignTapePoolOutput with field(s):
  • tape_arn(Option<String>):

    The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool.

• On failure, responds with SdkError<AssignTapePoolError>

impl Client

pub fn associate_file_system(&self) -> AssociateFileSystemFluentBuilder

Constructs a fluent builder for the AssociateFileSystem operation.

• The fluent builder is configurable:
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

    
    
  • password(impl Into<String>) / set_password(Option<String>):
    required: true
    

    The password of the user credential.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.

    
    
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.

    
    
  • audit_destination_arn(impl Into<String>) / set_audit_destination_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the storage used for the audit logs.

    
    
  • cache_attributes(CacheAttributes) / set_cache_attributes(Option<CacheAttributes>):
    required: false
    

    The refresh cache information for the file share or FSx file systems.

    
    
  • endpoint_network_configuration(EndpointNetworkConfiguration) / set_endpoint_network_configuration(Option<EndpointNetworkConfiguration>):
    required: false
    

    Specifies the network configuration information for the gateway associated with the Amazon FSx file system.

    If multiple file systems are associated with this gateway, this parameter’s IpAddresses field is required.

    
    
• On success, responds with AssociateFileSystemOutput with field(s):
  • file_system_association_arn(Option<String>):

    The ARN of the newly created file system association.

• On failure, responds with SdkError<AssociateFileSystemError>

impl Client

pub fn attach_volume(&self) -> AttachVolumeFluentBuilder

Constructs a fluent builder for the AttachVolume operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.

    
    
  • target_name(impl Into<String>) / set_target_name(Option<String>):
    required: false
    

    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. 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 used for this volume as the new target name.

    
    
  • volume_arn(impl Into<String>) / set_volume_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.

    
    
  • network_interface_id(impl Into<String>) / set_network_interface_id(Option<String>):
    required: true
    

    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

    Valid Values: A valid IP address.

    
    
  • disk_id(impl Into<String>) / set_disk_id(Option<String>):
    required: false
    

    The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.

    
    
• On success, responds with AttachVolumeOutput with field(s):
  • volume_arn(Option<String>):

    The Amazon Resource Name (ARN) of the volume that was attached to the gateway.

  • target_arn(Option<String>):

    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for the initiator that was used to connect to the target.

• On failure, responds with SdkError<AttachVolumeError>

impl Client

pub fn cancel_archival(&self) -> CancelArchivalFluentBuilder

Constructs a fluent builder for the CancelArchival operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • tape_arn(impl Into<String>) / set_tape_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.

    
    
• On success, responds with CancelArchivalOutput with field(s):
  • tape_arn(Option<String>):

    The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.

• On failure, responds with SdkError<CancelArchivalError>

impl Client

pub fn cancel_retrieval(&self) -> CancelRetrievalFluentBuilder

Constructs a fluent builder for the CancelRetrieval operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • tape_arn(impl Into<String>) / set_tape_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

    
    
• On success, responds with CancelRetrievalOutput with field(s):
  • tape_arn(Option<String>):

    The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.

• On failure, responds with SdkError<CancelRetrievalError>

impl Client

pub fn create_cachedi_scsi_volume(&self) -> CreateCachediSCSIVolumeFluentBuilder

Constructs a fluent builder for the CreateCachediSCSIVolume operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • volume_size_in_bytes(i64) / set_volume_size_in_bytes(Option<i64>):
    required: true
    

    The size of the volume in bytes.

    
    
  • snapshot_id(impl Into<String>) / set_snapshot_id(Option<String>):
    required: false
    

    The snapshot ID (e.g. “snap-1122aabb”) of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

    
    
  • target_name(impl Into<String>) / set_target_name(Option<String>):
    required: true
    

    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. 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 used for this volume as the new target name.

    
    
  • source_volume_arn(impl Into<String>) / set_source_volume_arn(Option<String>):
    required: false
    

    The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume’s latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

    
    
  • network_interface_id(impl Into<String>) / set_network_interface_id(Option<String>):
    required: true
    

    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

    Valid Values: A valid IP address.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

    
    
  • kms_encrypted(bool) / set_kms_encrypted(Option<bool>):
    required: false
    

    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

    Valid Values: true | false

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    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 value can only be set when KMSEncrypted is true. Optional.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256 characters.

    
    
• On success, responds with CreateCachediScsiVolumeOutput with field(s):
  • volume_arn(Option<String>):

    The Amazon Resource Name (ARN) of the configured volume.

  • target_arn(Option<String>):

    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

• On failure, responds with SdkError<CreateCachediSCSIVolumeError>

impl Client

pub fn create_nfs_file_share(&self) -> CreateNFSFileShareFluentBuilder

Constructs a fluent builder for the CreateNFSFileShare operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.

    
    
  • nfs_file_share_defaults(NfsFileShareDefaults) / set_nfs_file_share_defaults(Option<NfsFileShareDefaults>):
    required: false
    

    File share default values. Optional.

    
    
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.

    
    
  • kms_encrypted(bool) / set_kms_encrypted(Option<bool>):
    required: false
    

    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

    Valid Values: true | false

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    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 value can only be set when KMSEncrypted is true. Optional.

    
    
  • role(impl Into<String>) / set_role(Option<String>):
    required: true
    

    The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.

    
    
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

    A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).

    You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.

    Bucket ARN:

    arn:aws:s3:::my-bucket/prefix/

    Access point ARN:

    arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/

    If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

    Access point alias:

    test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

    
    
  • default_storage_class(impl Into<String>) / set_default_storage_class(Option<String>):
    required: false
    

    The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

    
    
  • object_acl(ObjectAcl) / set_object_acl(Option<ObjectAcl>):
    required: false
    

    A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.

    
    
  • client_list(impl Into<String>) / set_client_list(Option<Vec::<String>>):
    required: false
    

    The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.

    
    
  • squash(impl Into<String>) / set_squash(Option<String>):
    required: false
    

    A value that maps a user to anonymous user.

    Valid values are the following:

    • RootSquash: Only root is mapped to anonymous user.

    • NoSquash: No one is mapped to anonymous user.

    • AllSquash: Everyone is mapped to anonymous user.

    
    
  • read_only(bool) / set_read_only(Option<bool>):
    required: false
    

    A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

    Valid Values: true | false

    
    
  • guess_mime_type_enabled(bool) / set_guess_mime_type_enabled(Option<bool>):
    required: false
    

    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

    Valid Values: true | false

    
    
  • requester_pays(bool) / set_requester_pays(Option<bool>):
    required: false
    

    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

    Valid Values: true | false

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256.

    
    
  • file_share_name(impl Into<String>) / set_file_share_name(Option<String>):
    required: false
    

    The name of the file share. Optional.

    FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.

    
    
  • cache_attributes(CacheAttributes) / set_cache_attributes(Option<CacheAttributes>):
    required: false
    

    Specifies refresh cache information for the file share.

    
    
  • notification_policy(impl Into<String>) / set_notification_policy(Option<String>):
    required: false
    

    The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it’s best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

    SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

    The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

    {"Upload": {"SettlingTimeInSeconds": 60}}

    The following example sets NotificationPolicy off.

    {}

    
    
  • vpc_endpoint_dns_name(impl Into<String>) / set_vpc_endpoint_dns_name(Option<String>):
    required: false
    

    Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

    This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

    
    
  • bucket_region(impl Into<String>) / set_bucket_region(Option<String>):
    required: false
    

    Specifies the Region of the S3 bucket where the NFS file share stores files.

    This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

    
    
  • audit_destination_arn(impl Into<String>) / set_audit_destination_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the storage used for audit logs.

    
    
• On success, responds with CreateNfsFileShareOutput with field(s):
  • file_share_arn(Option<String>):

    The Amazon Resource Name (ARN) of the newly created file share.

• On failure, responds with SdkError<CreateNFSFileShareError>

impl Client

pub fn create_smb_file_share(&self) -> CreateSMBFileShareFluentBuilder

Constructs a fluent builder for the CreateSMBFileShare operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.

    
    
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The ARN of the S3 File Gateway on which you want to create a file share.

    
    
  • kms_encrypted(bool) / set_kms_encrypted(Option<bool>):
    required: false
    

    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

    Valid Values: true | false

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    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 value can only be set when KMSEncrypted is true. Optional.

    
    
  • role(impl Into<String>) / set_role(Option<String>):
    required: true
    

    The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.

    
    
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

    A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).

    You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.

    Bucket ARN:

    arn:aws:s3:::my-bucket/prefix/

    Access point ARN:

    arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/

    If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

    Access point alias:

    test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

    
    
  • default_storage_class(impl Into<String>) / set_default_storage_class(Option<String>):
    required: false
    

    The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

    
    
  • object_acl(ObjectAcl) / set_object_acl(Option<ObjectAcl>):
    required: false
    

    A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.

    
    
  • read_only(bool) / set_read_only(Option<bool>):
    required: false
    

    A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

    Valid Values: true | false

    
    
  • guess_mime_type_enabled(bool) / set_guess_mime_type_enabled(Option<bool>):
    required: false
    

    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

    Valid Values: true | false

    
    
  • requester_pays(bool) / set_requester_pays(Option<bool>):
    required: false
    

    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

    Valid Values: true | false

    
    
  • smbacl_enabled(bool) / set_smbacl_enabled(Option<bool>):
    required: false
    

    Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.

    For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

    Valid Values: true | false

    
    
  • access_based_enumeration(bool) / set_access_based_enumeration(Option<bool>):
    required: false
    

    The files and folders on this share will only be visible to users with read access.

    
    
  • admin_user_list(impl Into<String>) / set_admin_user_list(Option<Vec::<String>>):
    required: false
    

    A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1.

    Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

    
    
  • valid_user_list(impl Into<String>) / set_valid_user_list(Option<Vec::<String>>):
    required: false
    

    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

    
    
  • invalid_user_list(impl Into<String>) / set_invalid_user_list(Option<Vec::<String>>):
    required: false
    

    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

    
    
  • audit_destination_arn(impl Into<String>) / set_audit_destination_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the storage used for audit logs.

    
    
  • authentication(impl Into<String>) / set_authentication(Option<String>):
    required: false
    

    The authentication method that users use to access the file share. The default is ActiveDirectory.

    Valid Values: ActiveDirectory | GuestAccess

    
    
  • case_sensitivity(CaseSensitivity) / set_case_sensitivity(Option<CaseSensitivity>):
    required: false
    

    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256.

    
    
  • file_share_name(impl Into<String>) / set_file_share_name(Option<String>):
    required: false
    

    The name of the file share. Optional.

    FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.

    
    
  • cache_attributes(CacheAttributes) / set_cache_attributes(Option<CacheAttributes>):
    required: false
    

    Specifies refresh cache information for the file share.

    
    
  • notification_policy(impl Into<String>) / set_notification_policy(Option<String>):
    required: false
    

    The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it’s best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

    SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

    The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

    {"Upload": {"SettlingTimeInSeconds": 60}}

    The following example sets NotificationPolicy off.

    {}

    
    
  • vpc_endpoint_dns_name(impl Into<String>) / set_vpc_endpoint_dns_name(Option<String>):
    required: false
    

    Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.

    This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

    
    
  • bucket_region(impl Into<String>) / set_bucket_region(Option<String>):
    required: false
    

    Specifies the Region of the S3 bucket where the SMB file share stores files.

    This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

    
    
  • oplocks_enabled(bool) / set_oplocks_enabled(Option<bool>):
    required: false
    

    Specifies whether opportunistic locking is enabled for the SMB file share.

    Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.

    Valid Values: true | false

    
    
• On success, responds with CreateSmbFileShareOutput with field(s):
  • file_share_arn(Option<String>):

    The Amazon Resource Name (ARN) of the newly created file share.

• On failure, responds with SdkError<CreateSMBFileShareError>

impl Client

pub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder

Constructs a fluent builder for the CreateSnapshot operation.

• The fluent builder is configurable:
  • volume_arn(impl Into<String>) / set_volume_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    
    
  • snapshot_description(impl Into<String>) / set_snapshot_description(Option<String>):
    required: true
    

    Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256.

    
    
• On success, responds with CreateSnapshotOutput with field(s):
  • volume_arn(Option<String>):

    The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.

  • snapshot_id(Option<String>):

    The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume).

• On failure, responds with SdkError<CreateSnapshotError>

impl Client

pub fn create_snapshot_from_volume_recovery_point( &self, ) -> CreateSnapshotFromVolumeRecoveryPointFluentBuilder

Constructs a fluent builder for the CreateSnapshotFromVolumeRecoveryPoint operation.

• The fluent builder is configurable:
  • volume_arn(impl Into<String>) / set_volume_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

    
    
  • snapshot_description(impl Into<String>) / set_snapshot_description(Option<String>):
    required: true
    

    Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256.

    
    
• On success, responds with CreateSnapshotFromVolumeRecoveryPointOutput with field(s):
  • snapshot_id(Option<String>):

    The ID of the snapshot.

  • volume_arn(Option<String>):

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

  • volume_recovery_point_time(Option<String>):

    The time the volume was created from the recovery point.

• On failure, responds with SdkError<CreateSnapshotFromVolumeRecoveryPointError>

impl Client

pub fn create_storedi_scsi_volume(&self) -> CreateStorediSCSIVolumeFluentBuilder

Constructs a fluent builder for the CreateStorediSCSIVolume operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • disk_id(impl Into<String>) / set_disk_id(Option<String>):
    required: true
    

    The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

    
    
  • snapshot_id(impl Into<String>) / set_snapshot_id(Option<String>):
    required: false
    

    The snapshot ID (e.g., “snap-1122aabb”) of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

    
    
  • preserve_existing_data(bool) / set_preserve_existing_data(Option<bool>):
    required: true
    

    Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

    Valid Values: true | false

    
    
  • target_name(impl Into<String>) / set_target_name(Option<String>):
    required: true
    

    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. 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 used for this volume as the new target name.

    
    
  • network_interface_id(impl Into<String>) / set_network_interface_id(Option<String>):
    required: true
    

    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

    Valid Values: A valid IP address.

    
    
  • kms_encrypted(bool) / set_kms_encrypted(Option<bool>):
    required: false
    

    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

    Valid Values: true | false

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    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 value can only be set when KMSEncrypted is true. Optional.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256.

    
    
• On success, responds with CreateStorediScsiVolumeOutput with field(s):
  • volume_arn(Option<String>):

    The Amazon Resource Name (ARN) of the configured volume.

  • volume_size_in_bytes(i64):

    The size of the volume in bytes.

  • target_arn(Option<String>):

    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

• On failure, responds with SdkError<CreateStorediSCSIVolumeError>

impl Client

pub fn create_tape_pool(&self) -> CreateTapePoolFluentBuilder

Constructs a fluent builder for the CreateTapePool operation.

• The fluent builder is configurable:
  • pool_name(impl Into<String>) / set_pool_name(Option<String>):
    required: true
    

    The name of the new custom tape pool.

    
    
  • storage_class(TapeStorageClass) / set_storage_class(Option<TapeStorageClass>):
    required: true
    

    The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    
    
  • retention_lock_type(RetentionLockType) / set_retention_lock_type(Option<RetentionLockType>):
    required: false
    

    Tape retention lock can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.

    
    
  • retention_lock_time_in_days(i32) / set_retention_lock_time_in_days(Option<i32>):
    required: false
    

    Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256.

    
    
• On success, responds with CreateTapePoolOutput with field(s):
  • pool_arn(Option<String>):

    The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the ListTapePools operation to return a list of tape pools for your account and Amazon Web Services Region.

• On failure, responds with SdkError<CreateTapePoolError>

impl Client

pub fn create_tape_with_barcode(&self) -> CreateTapeWithBarcodeFluentBuilder

Constructs a fluent builder for the CreateTapeWithBarcode operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • tape_size_in_bytes(i64) / set_tape_size_in_bytes(Option<i64>):
    required: true
    

    The size, in bytes, of the virtual tape that you want to create.

    The size must be aligned by gigabyte (102410241024 bytes).

    
    
  • tape_barcode(impl Into<String>) / set_tape_barcode(Option<String>):
    required: true
    

    The barcode that you want to assign to the tape.

    Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

    
    
  • kms_encrypted(bool) / set_kms_encrypted(Option<bool>):
    required: false
    

    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

    Valid Values: true | false

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    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 value can only be set when KMSEncrypted is true. Optional.

    
    
  • pool_id(impl Into<String>) / set_pool_id(Option<String>):
    required: false
    

    The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.

    
    
  • worm(bool) / set_worm(Option<bool>):
    required: false
    

    Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256.

    
    
• On success, responds with CreateTapeWithBarcodeOutput with field(s):
  • tape_arn(Option<String>):

    A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.

• On failure, responds with SdkError<CreateTapeWithBarcodeError>

impl Client

pub fn create_tapes(&self) -> CreateTapesFluentBuilder

Constructs a fluent builder for the CreateTapes operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • tape_size_in_bytes(i64) / set_tape_size_in_bytes(Option<i64>):
    required: true
    

    The size, in bytes, of the virtual tapes that you want to create.

    The size must be aligned by gigabyte (102410241024 bytes).

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

    Using the same ClientToken prevents creating the tape multiple times.

    
    
  • num_tapes_to_create(i32) / set_num_tapes_to_create(Option<i32>):
    required: true
    

    The number of virtual tapes that you want to create.

    
    
  • tape_barcode_prefix(impl Into<String>) / set_tape_barcode_prefix(Option<String>):
    required: true
    

    A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.

    The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.

    
    
  • kms_encrypted(bool) / set_kms_encrypted(Option<bool>):
    required: false
    

    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

    Valid Values: true | false

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    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 value can only be set when KMSEncrypted is true. Optional.

    
    
  • pool_id(impl Into<String>) / set_pool_id(Option<String>):
    required: false
    

    The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    
    
  • worm(bool) / set_worm(Option<bool>):
    required: false
    

    Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256.

    
    
• On success, responds with CreateTapesOutput with field(s):
  • tape_arns(Option<Vec::<String>>):

    A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.

• On failure, responds with SdkError<CreateTapesError>

impl Client

pub fn delete_automatic_tape_creation_policy( &self, ) -> DeleteAutomaticTapeCreationPolicyFluentBuilder

Constructs a fluent builder for the DeleteAutomaticTapeCreationPolicy operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DeleteAutomaticTapeCreationPolicyOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<DeleteAutomaticTapeCreationPolicyError>

impl Client

pub fn delete_bandwidth_rate_limit( &self, ) -> DeleteBandwidthRateLimitFluentBuilder

Constructs a fluent builder for the DeleteBandwidthRateLimit operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • bandwidth_type(impl Into<String>) / set_bandwidth_type(Option<String>):
    required: true
    

    One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.

    Valid Values: UPLOAD | DOWNLOAD | ALL

    
    
• On success, responds with DeleteBandwidthRateLimitOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<DeleteBandwidthRateLimitError>

impl Client

pub fn delete_chap_credentials(&self) -> DeleteChapCredentialsFluentBuilder

Constructs a fluent builder for the DeleteChapCredentials operation.

• The fluent builder is configurable:
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

    
    
  • initiator_name(impl Into<String>) / set_initiator_name(Option<String>):
    required: true
    

    The iSCSI initiator that connects to the target.

    
    
• On success, responds with DeleteChapCredentialsOutput with field(s):
  • target_arn(Option<String>):

    The Amazon Resource Name (ARN) of the target.

  • initiator_name(Option<String>):

    The iSCSI initiator that connects to the target.

• On failure, responds with SdkError<DeleteChapCredentialsError>

impl Client

pub fn delete_file_share(&self) -> DeleteFileShareFluentBuilder

Constructs a fluent builder for the DeleteFileShare operation.

• The fluent builder is configurable:
  • file_share_arn(impl Into<String>) / set_file_share_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the file share to be deleted.

    
    
  • force_delete(bool) / set_force_delete(Option<bool>):
    required: false
    

    If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share is not deleted until all data is uploaded to Amazon Web Services. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

    Valid Values: true | false

    
    
• On success, responds with DeleteFileShareOutput with field(s):
  • file_share_arn(Option<String>):

    The Amazon Resource Name (ARN) of the deleted file share.

• On failure, responds with SdkError<DeleteFileShareError>

impl Client

pub fn delete_gateway(&self) -> DeleteGatewayFluentBuilder

Constructs a fluent builder for the DeleteGateway operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DeleteGatewayOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<DeleteGatewayError>

impl Client

pub fn delete_snapshot_schedule(&self) -> DeleteSnapshotScheduleFluentBuilder

Constructs a fluent builder for the DeleteSnapshotSchedule operation.

• The fluent builder is configurable:
  • volume_arn(impl Into<String>) / set_volume_arn(Option<String>):
    required: true
    

    The volume which snapshot schedule to delete.

    
    
• On success, responds with DeleteSnapshotScheduleOutput with field(s):
  • volume_arn(Option<String>):

    The volume which snapshot schedule was deleted.

• On failure, responds with SdkError<DeleteSnapshotScheduleError>

impl Client

pub fn delete_tape(&self) -> DeleteTapeFluentBuilder

Constructs a fluent builder for the DeleteTape operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • tape_arn(impl Into<String>) / set_tape_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the virtual tape to delete.

    
    
  • bypass_governance_retention(bool) / set_bypass_governance_retention(Option<bool>):
    required: false
    

    Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can’t be deleted.

    
    
• On success, responds with DeleteTapeOutput with field(s):
  • tape_arn(Option<String>):

    The Amazon Resource Name (ARN) of the deleted virtual tape.

• On failure, responds with SdkError<DeleteTapeError>

impl Client

pub fn delete_tape_archive(&self) -> DeleteTapeArchiveFluentBuilder

Constructs a fluent builder for the DeleteTapeArchive operation.

• The fluent builder is configurable:
  • tape_arn(impl Into<String>) / set_tape_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).

    
    
  • bypass_governance_retention(bool) / set_bypass_governance_retention(Option<bool>):
    required: false
    

    Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can’t be deleted.

    
    
• On success, responds with DeleteTapeArchiveOutput with field(s):
  • tape_arn(Option<String>):

    The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).

• On failure, responds with SdkError<DeleteTapeArchiveError>

impl Client

pub fn delete_tape_pool(&self) -> DeleteTapePoolFluentBuilder

Constructs a fluent builder for the DeleteTapePool operation.

• The fluent builder is configurable:
  • pool_arn(impl Into<String>) / set_pool_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the custom tape pool to delete.

    
    
• On success, responds with DeleteTapePoolOutput with field(s):
  • pool_arn(Option<String>):

    The Amazon Resource Name (ARN) of the custom tape pool being deleted.

• On failure, responds with SdkError<DeleteTapePoolError>

impl Client

pub fn delete_volume(&self) -> DeleteVolumeFluentBuilder

Constructs a fluent builder for the DeleteVolume operation.

• The fluent builder is configurable:
  • volume_arn(impl Into<String>) / set_volume_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    
    
• On success, responds with DeleteVolumeOutput with field(s):
  • volume_arn(Option<String>):

    The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.

• On failure, responds with SdkError<DeleteVolumeError>

impl Client

pub fn describe_availability_monitor_test( &self, ) -> DescribeAvailabilityMonitorTestFluentBuilder

Constructs a fluent builder for the DescribeAvailabilityMonitorTest operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DescribeAvailabilityMonitorTestOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • status(Option<AvailabilityMonitorTestStatus>):

    The status of the high availability monitoring test. If a test hasn’t been performed, the value of this field is null.

  • start_time(Option<DateTime>):

    The time the high availability monitoring test was started. If a test hasn’t been performed, the value of this field is null.

• On failure, responds with SdkError<DescribeAvailabilityMonitorTestError>

impl Client

pub fn describe_bandwidth_rate_limit( &self, ) -> DescribeBandwidthRateLimitFluentBuilder

Constructs a fluent builder for the DescribeBandwidthRateLimit operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DescribeBandwidthRateLimitOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • average_upload_rate_limit_in_bits_per_sec(Option<i64>):

    The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.

  • average_download_rate_limit_in_bits_per_sec(Option<i64>):

    The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.

• On failure, responds with SdkError<DescribeBandwidthRateLimitError>

impl Client

pub fn describe_bandwidth_rate_limit_schedule( &self, ) -> DescribeBandwidthRateLimitScheduleFluentBuilder

Constructs a fluent builder for the DescribeBandwidthRateLimitSchedule operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DescribeBandwidthRateLimitScheduleOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • bandwidth_rate_limit_intervals(Option<Vec::<BandwidthRateLimitInterval>>):

    An array that contains the bandwidth rate limit intervals for a tape or volume gateway.

• On failure, responds with SdkError<DescribeBandwidthRateLimitScheduleError>

impl Client

pub fn describe_cache(&self) -> DescribeCacheFluentBuilder

Constructs a fluent builder for the DescribeCache operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DescribeCacheOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • disk_ids(Option<Vec::<String>>):

    An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

  • cache_allocated_in_bytes(i64):

    The amount of cache in bytes allocated to a gateway.

  • cache_used_percentage(f64):

    Percent use of the gateway’s cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.

  • cache_dirty_percentage(f64):

    The file share’s contribution to the overall percentage of the gateway’s cache that has not been persisted to Amazon Web Services. The sample is taken at the end of the reporting period.

  • cache_hit_percentage(f64):

    Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.

  • cache_miss_percentage(f64):

    Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.

• On failure, responds with SdkError<DescribeCacheError>

impl Client

pub fn describe_cachedi_scsi_volumes( &self, ) -> DescribeCachediSCSIVolumesFluentBuilder

Constructs a fluent builder for the DescribeCachediSCSIVolumes operation.

• The fluent builder is configurable:
  • volume_arns(impl Into<String>) / set_volume_arns(Option<Vec::<String>>):
    required: true
    

    An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

    
    
• On success, responds with DescribeCachediScsiVolumesOutput with field(s):
  • cachedi_scsi_volumes(Option<Vec::<CachediScsiVolume>>):

    An array of objects where each object contains metadata about one cached volume.

• On failure, responds with SdkError<DescribeCachediSCSIVolumesError>

impl Client

pub fn describe_chap_credentials(&self) -> DescribeChapCredentialsFluentBuilder

Constructs a fluent builder for the DescribeChapCredentials operation.

• The fluent builder is configurable:
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

    
    
• On success, responds with DescribeChapCredentialsOutput with field(s):
  • chap_credentials(Option<Vec::<ChapInfo>>):

    An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

    • InitiatorName: The iSCSI initiator that connects to the target.

    • SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

    • SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

    • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

• On failure, responds with SdkError<DescribeChapCredentialsError>

impl Client

pub fn describe_file_system_associations( &self, ) -> DescribeFileSystemAssociationsFluentBuilder

Constructs a fluent builder for the DescribeFileSystemAssociations operation.

• The fluent builder is configurable:
  • file_system_association_arn_list(impl Into<String>) / set_file_system_association_arn_list(Option<Vec::<String>>):
    required: true
    

    An array containing the Amazon Resource Name (ARN) of each file system association to be described.

    
    
• On success, responds with DescribeFileSystemAssociationsOutput with field(s):
  • file_system_association_info_list(Option<Vec::<FileSystemAssociationInfo>>):

    An array containing the FileSystemAssociationInfo data type of each file system association to be described.

• On failure, responds with SdkError<DescribeFileSystemAssociationsError>

impl Client

pub fn describe_gateway_information( &self, ) -> DescribeGatewayInformationFluentBuilder

Constructs a fluent builder for the DescribeGatewayInformation operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DescribeGatewayInformationOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • gateway_id(Option<String>):

    The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

  • gateway_name(Option<String>):

    The name you configured for your gateway.

  • gateway_timezone(Option<String>):

    A value that indicates the time zone configured for the gateway.

  • gateway_state(Option<String>):

    A value that indicates the operating state of the gateway.

  • gateway_network_interfaces(Option<Vec::<NetworkInterface>>):

    A NetworkInterface array that contains descriptions of the gateway network interfaces.

  • gateway_type(Option<String>):

    The type of the gateway.

  • next_update_availability_date(Option<String>):

    The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

  • last_software_update(Option<String>):

    The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

  • ec2_instance_id(Option<String>):

    The ID of the Amazon EC2 instance that was used to launch the gateway.

  • ec2_instance_region(Option<String>):

    The Amazon Web Services Region where the Amazon EC2 instance is located.

  • tags(Option<Vec::<Tag>>):

    A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

  • vpc_endpoint(Option<String>):

    The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

  • cloud_watch_log_group_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

  • host_environment(Option<HostEnvironment>):

    The type of hardware or software platform on which the gateway is running.

    Tape Gateway is no longer available on Snow Family devices.

  • endpoint_type(Option<String>):

    The type of endpoint for your gateway.

    Valid Values: STANDARD | FIPS

  • software_updates_end_date(Option<String>):

    Date after which this gateway will not receive software updates for new features.

  • deprecation_date(Option<String>):

    Date after which this gateway will not receive software updates for new features and bug fixes.

  • gateway_capacity(Option<GatewayCapacity>):

    Specifies the size of the gateway’s metadata cache.

  • supported_gateway_capacities(Option<Vec::<GatewayCapacity>>):

    A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

  • host_environment_id(Option<String>):

    A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

  • software_version(Option<String>):

    The version number of the software running on the gateway appliance.

• On failure, responds with SdkError<DescribeGatewayInformationError>

impl Client

pub fn describe_maintenance_start_time( &self, ) -> DescribeMaintenanceStartTimeFluentBuilder

Constructs a fluent builder for the DescribeMaintenanceStartTime operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DescribeMaintenanceStartTimeOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • hour_of_day(Option<i32>):

    The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

  • minute_of_hour(Option<i32>):

    The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.

  • day_of_week(Option<i32>):

    An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.

  • day_of_month(Option<i32>):

    The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month. It is not possible to set the maintenance schedule to start on days 29 through 31.

  • timezone(Option<String>):

    A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway.

  • software_update_preferences(Option<SoftwareUpdatePreferences>):

    A set of variables indicating the software update preferences for the gateway.

    Includes AutomaticUpdatePolicy field with the following inputs:

    ALL_VERSIONS - Enables regular gateway maintenance updates.

    EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.

• On failure, responds with SdkError<DescribeMaintenanceStartTimeError>

impl Client

pub fn describe_nfs_file_shares(&self) -> DescribeNFSFileSharesFluentBuilder

Constructs a fluent builder for the DescribeNFSFileShares operation.

• The fluent builder is configurable:
  • file_share_arn_list(impl Into<String>) / set_file_share_arn_list(Option<Vec::<String>>):
    required: true
    

    An array containing the Amazon Resource Name (ARN) of each file share to be described.

    
    
• On success, responds with DescribeNfsFileSharesOutput with field(s):
  • nfs_file_share_info_list(Option<Vec::<NfsFileShareInfo>>):

    An array containing a description for each requested file share.

• On failure, responds with SdkError<DescribeNFSFileSharesError>

impl Client

pub fn describe_smb_file_shares(&self) -> DescribeSMBFileSharesFluentBuilder

Constructs a fluent builder for the DescribeSMBFileShares operation.

• The fluent builder is configurable:
  • file_share_arn_list(impl Into<String>) / set_file_share_arn_list(Option<Vec::<String>>):
    required: true
    

    An array containing the Amazon Resource Name (ARN) of each file share to be described.

    
    
• On success, responds with DescribeSmbFileSharesOutput with field(s):
  • smb_file_share_info_list(Option<Vec::<SmbFileShareInfo>>):

    An array containing a description for each requested file share.

• On failure, responds with SdkError<DescribeSMBFileSharesError>

impl Client

pub fn describe_smb_settings(&self) -> DescribeSMBSettingsFluentBuilder

Constructs a fluent builder for the DescribeSMBSettings operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DescribeSmbSettingsOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • domain_name(Option<String>):

    The name of the domain that the gateway is joined to.

  • active_directory_status(Option<ActiveDirectoryStatus>):

    Indicates the status of a gateway that is a member of the Active Directory domain.

    • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

    • DETACHED: Indicates that gateway is not joined to a domain.

    • JOINED: Indicates that the gateway has successfully joined a domain.

    • JOINING: Indicates that a JoinDomain operation is in progress.

    • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

    • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn’t complete within the allotted time.

    • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

  • smb_guest_password_set(Option<bool>):

    This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

    Valid Values: true | false

  • smb_security_strategy(Option<SmbSecurityStrategy>):

    The type of security strategy that was specified for file gateway.

    • ClientSpecified: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway.

    • MandatorySigning: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later.

    • MandatoryEncryption: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.

    • MandatoryEncryptionNoAes128: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.

  • file_shares_visible(Option<bool>):

    The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

  • smb_local_groups(Option<SmbLocalGroups>):

    A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

• On failure, responds with SdkError<DescribeSMBSettingsError>

impl Client

pub fn describe_snapshot_schedule( &self, ) -> DescribeSnapshotScheduleFluentBuilder

Constructs a fluent builder for the DescribeSnapshotSchedule operation.

• The fluent builder is configurable:
  • volume_arn(impl Into<String>) / set_volume_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    
    
• On success, responds with DescribeSnapshotScheduleOutput with field(s):
  • volume_arn(Option<String>):

    The Amazon Resource Name (ARN) of the volume that was specified in the request.

  • start_at(Option<i32>):

    The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

  • recurrence_in_hours(Option<i32>):

    The number of hours between snapshots.

  • description(Option<String>):

    The snapshot description.

  • timezone(Option<String>):

    A value that indicates the time zone of the gateway.

  • tags(Option<Vec::<Tag>>):

    A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

• On failure, responds with SdkError<DescribeSnapshotScheduleError>

impl Client

pub fn describe_storedi_scsi_volumes( &self, ) -> DescribeStorediSCSIVolumesFluentBuilder

Constructs a fluent builder for the DescribeStorediSCSIVolumes operation.

• The fluent builder is configurable:
  • volume_arns(impl Into<String>) / set_volume_arns(Option<Vec::<String>>):
    required: true
    

    An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

    
    
• On success, responds with DescribeStorediScsiVolumesOutput with field(s):
  • storedi_scsi_volumes(Option<Vec::<StorediScsiVolume>>):

    Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

    • ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.

    • LunNumber: The logical disk number.

    • NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.

    • NetworkInterfacePort: The port used to communicate with iSCSI targets.

    • PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying local disk was preserved.

    • SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.

    • StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.

    • TargetARN: The Amazon Resource Name (ARN) of the volume target.

    • VolumeARN: The Amazon Resource Name (ARN) of the stored volume.

    • VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

    • VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.

    • VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

    • VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

    • VolumeSizeInBytes: The size of the volume in bytes.

    • VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.

    • VolumeType: One of the enumeration values describing the type of the volume. Currently, only STORED volumes are supported.

• On failure, responds with SdkError<DescribeStorediSCSIVolumesError>

impl Client

pub fn describe_tape_archives(&self) -> DescribeTapeArchivesFluentBuilder

Constructs a fluent builder for the DescribeTapeArchives operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • tape_arns(impl Into<String>) / set_tape_arns(Option<Vec::<String>>):
    required: false
    

    Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An opaque string that indicates the position at which to begin describing virtual tapes.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies that the number of virtual tapes described be limited to the specified number.

    
    
• On success, responds with DescribeTapeArchivesOutput with field(s):
  • tape_archives(Option<Vec::<TapeArchive>>):

    An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode.

  • marker(Option<String>):

    An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.

• On failure, responds with SdkError<DescribeTapeArchivesError>

impl Client

pub fn describe_tape_recovery_points( &self, ) -> DescribeTapeRecoveryPointsFluentBuilder

Constructs a fluent builder for the DescribeTapeRecoveryPoints operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An opaque string that indicates the position at which to begin describing the virtual tape recovery points.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies that the number of virtual tape recovery points that are described be limited to the specified number.

    
    
• On success, responds with DescribeTapeRecoveryPointsOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • tape_recovery_point_infos(Option<Vec::<TapeRecoveryPointInfo>>):

    An array of TapeRecoveryPointInfos that are available for the specified gateway.

  • marker(Option<String>):

    An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.

    Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.

• On failure, responds with SdkError<DescribeTapeRecoveryPointsError>

impl Client

pub fn describe_tapes(&self) -> DescribeTapesFluentBuilder

Constructs a fluent builder for the DescribeTapes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • tape_arns(impl Into<String>) / set_tape_arns(Option<Vec::<String>>):
    required: false
    

    Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

    If not specified, the first page of results is retrieved.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies that the number of virtual tapes described be limited to the specified number.

    Amazon Web Services may impose its own limit, if this field is not set.

    
    
• On success, responds with DescribeTapesOutput with field(s):
  • tapes(Option<Vec::<Tape>>):

    An array of virtual tape descriptions.

  • marker(Option<String>):

    An opaque string that can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.

    If a response does not contain a marker, then there are no more results to be retrieved.

• On failure, responds with SdkError<DescribeTapesError>

impl Client

pub fn describe_upload_buffer(&self) -> DescribeUploadBufferFluentBuilder

Constructs a fluent builder for the DescribeUploadBuffer operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DescribeUploadBufferOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • disk_ids(Option<Vec::<String>>):

    An array of the gateway’s local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

  • upload_buffer_used_in_bytes(i64):

    The total number of bytes being used in the gateway’s upload buffer.

  • upload_buffer_allocated_in_bytes(i64):

    The total number of bytes allocated in the gateway’s as upload buffer.

• On failure, responds with SdkError<DescribeUploadBufferError>

impl Client

pub fn describe_vtl_devices(&self) -> DescribeVTLDevicesFluentBuilder

Constructs a fluent builder for the DescribeVTLDevices operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • vtl_device_arns(impl Into<String>) / set_vtl_device_arns(Option<Vec::<String>>):
    required: false
    

    An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

    All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An opaque string that indicates the position at which to begin describing the VTL devices.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies that the number of VTL devices described be limited to the specified number.

    
    
• On success, responds with DescribeVtlDevicesOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • vtl_devices(Option<Vec::<VtlDevice>>):

    An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.

  • marker(Option<String>):

    An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.

• On failure, responds with SdkError<DescribeVTLDevicesError>

impl Client

pub fn describe_working_storage(&self) -> DescribeWorkingStorageFluentBuilder

Constructs a fluent builder for the DescribeWorkingStorage operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DescribeWorkingStorageOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • disk_ids(Option<Vec::<String>>):

    An array of the gateway’s local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

  • working_storage_used_in_bytes(i64):

    The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

  • working_storage_allocated_in_bytes(i64):

    The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

• On failure, responds with SdkError<DescribeWorkingStorageError>

impl Client

pub fn detach_volume(&self) -> DetachVolumeFluentBuilder

Constructs a fluent builder for the DetachVolume operation.

• The fluent builder is configurable:
  • volume_arn(impl Into<String>) / set_volume_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the volume to detach from the gateway.

    
    
  • force_detach(bool) / set_force_detach(Option<bool>):
    required: false
    

    Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

    Valid Values: true | false

    
    
• On success, responds with DetachVolumeOutput with field(s):
  • volume_arn(Option<String>):

    The Amazon Resource Name (ARN) of the volume that was detached.

• On failure, responds with SdkError<DetachVolumeError>

impl Client

pub fn disable_gateway(&self) -> DisableGatewayFluentBuilder

Constructs a fluent builder for the DisableGateway operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with DisableGatewayOutput with field(s):
  • gateway_arn(Option<String>):

    The unique Amazon Resource Name (ARN) of the disabled gateway.

• On failure, responds with SdkError<DisableGatewayError>

impl Client

pub fn disassociate_file_system(&self) -> DisassociateFileSystemFluentBuilder

Constructs a fluent builder for the DisassociateFileSystem operation.

• The fluent builder is configurable:
  • file_system_association_arn(impl Into<String>) / set_file_system_association_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the file system association to be deleted.

    
    
  • force_delete(bool) / set_force_delete(Option<bool>):
    required: false
    

    If this value is set to true, the operation disassociates an Amazon FSx file system immediately. It ends all data uploads to the file system, and the file system association enters the FORCE_DELETING status. If this value is set to false, the Amazon FSx file system does not disassociate until all data is uploaded.

    
    
• On success, responds with DisassociateFileSystemOutput with field(s):
  • file_system_association_arn(Option<String>):

    The Amazon Resource Name (ARN) of the deleted file system association.

• On failure, responds with SdkError<DisassociateFileSystemError>

impl Client

pub fn join_domain(&self) -> JoinDomainFluentBuilder

Constructs a fluent builder for the JoinDomain operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The name of the domain that you want the gateway to join.

    
    
  • organizational_unit(impl Into<String>) / set_organizational_unit(Option<String>):
    required: false
    

    The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.

    
    
  • domain_controllers(impl Into<String>) / set_domain_controllers(Option<Vec::<String>>):
    required: false
    

    List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.

    
    
  • timeout_in_seconds(i32) / set_timeout_in_seconds(Option<i32>):
    required: false
    

    Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.

    
    
  • password(impl Into<String>) / set_password(Option<String>):
    required: true
    

    Sets the password of the user who has permission to add the gateway to the Active Directory domain.

    
    
• On success, responds with JoinDomainOutput with field(s):
  • gateway_arn(Option<String>):

    The unique Amazon Resource Name (ARN) of the gateway that joined the domain.

  • active_directory_status(Option<ActiveDirectoryStatus>):

    Indicates the status of the gateway as a member of the Active Directory domain.

    • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

    • DETACHED: Indicates that gateway is not joined to a domain.

    • JOINED: Indicates that the gateway has successfully joined a domain.

    • JOINING: Indicates that a JoinDomain operation is in progress.

    • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

    • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn’t complete within the allotted time.

    • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

• On failure, responds with SdkError<JoinDomainError>

impl Client

pub fn list_automatic_tape_creation_policies( &self, ) -> ListAutomaticTapeCreationPoliciesFluentBuilder

Constructs a fluent builder for the ListAutomaticTapeCreationPolicies operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with ListAutomaticTapeCreationPoliciesOutput with field(s):
  • automatic_tape_creation_policy_infos(Option<Vec::<AutomaticTapeCreationPolicyInfo>>):

    Gets a listing of information about the gateway’s automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.

• On failure, responds with SdkError<ListAutomaticTapeCreationPoliciesError>

impl Client

pub fn list_file_shares(&self) -> ListFileSharesFluentBuilder

Constructs a fluent builder for the ListFileShares operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    Opaque pagination token returned from a previous ListFileShares operation. If present, Marker specifies where to continue the list from after a previous call to ListFileShares. Optional.

    
    
• On success, responds with ListFileSharesOutput with field(s):
  • marker(Option<String>):

    If the request includes Marker, the response returns that value in this field.

  • next_marker(Option<String>):

    If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.

  • file_share_info_list(Option<Vec::<FileShareInfo>>):

    An array of information about the S3 File Gateway’s file shares.

• On failure, responds with SdkError<ListFileSharesError>

impl Client

pub fn list_file_system_associations( &self, ) -> ListFileSystemAssociationsFluentBuilder

Constructs a fluent builder for the ListFileSystemAssociations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The maximum number of file system associations to return in the response. If present, Limit must be an integer with a value greater than zero. Optional.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    Opaque pagination token returned from a previous ListFileSystemAssociations operation. If present, Marker specifies where to continue the list from after a previous call to ListFileSystemAssociations. Optional.

    
    
• On success, responds with ListFileSystemAssociationsOutput with field(s):
  • marker(Option<String>):

    If the request includes Marker, the response returns that value in this field.

  • next_marker(Option<String>):

    If a value is present, there are more file system associations to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file system associations.

  • file_system_association_summary_list(Option<Vec::<FileSystemAssociationSummary>>):

    An array of information about the Amazon FSx gateway’s file system associations.

• On failure, responds with SdkError<ListFileSystemAssociationsError>

impl Client

pub fn list_gateways(&self) -> ListGatewaysFluentBuilder

Constructs a fluent builder for the ListGateways operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An opaque string that indicates the position at which to begin the returned list of gateways.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies that the list of gateways returned be limited to the specified number of items.

    
    
• On success, responds with ListGatewaysOutput with field(s):
  • gateways(Option<Vec::<GatewayInfo>>):

    An array of GatewayInfo objects.

  • marker(Option<String>):

    Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.

• On failure, responds with SdkError<ListGatewaysError>

impl Client

pub fn list_local_disks(&self) -> ListLocalDisksFluentBuilder

Constructs a fluent builder for the ListLocalDisks operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with ListLocalDisksOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • disks(Option<Vec::<Disk>>):

    A JSON object containing the following fields:

    • ListLocalDisksOutput$Disks

• On failure, responds with SdkError<ListLocalDisksError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource for which you want to list tags.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An opaque string that indicates the position at which to begin returning the list of tags.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies that the list of tags returned be limited to the specified number of items.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource for which you want to list tags.

  • marker(Option<String>):

    An opaque string that indicates the position at which to stop returning the list of tags.

  • tags(Option<Vec::<Tag>>):

    An array that contains the tags for the specified resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_tape_pools(&self) -> ListTapePoolsFluentBuilder

Constructs a fluent builder for the ListTapePools operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • pool_arns(impl Into<String>) / set_pool_arns(Option<Vec::<String>>):
    required: false
    

    The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don’t specify a custom tape pool ARN, the response lists all custom tape pools.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    A string that indicates the position at which to begin the returned list of tape pools.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    An optional number limit for the tape pools in the list returned by this call.

    
    
• On success, responds with ListTapePoolsOutput with field(s):
  • pool_infos(Option<Vec::<PoolInfo>>):

    An array of PoolInfo objects, where each object describes a single custom tape pool. If there are no custom tape pools, the PoolInfos is an empty array.

  • marker(Option<String>):

    A string that indicates the position at which to begin the returned list of tape pools. Use the marker in your next request to continue pagination of tape pools. If there are no more tape pools to list, this element does not appear in the response body.

• On failure, responds with SdkError<ListTapePoolsError>

impl Client

pub fn list_tapes(&self) -> ListTapesFluentBuilder

Constructs a fluent builder for the ListTapes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • tape_arns(impl Into<String>) / set_tape_arns(Option<Vec::<String>>):
    required: false
    

    The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don’t specify a tape ARN, the response lists all tapes in both your VTL and VTS.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    A string that indicates the position at which to begin the returned list of tapes.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    An optional number limit for the tapes in the list returned by this call.

    
    
• On success, responds with ListTapesOutput with field(s):
  • tape_infos(Option<Vec::<TapeInfo>>):

    An array of TapeInfo objects, where each object describes a single tape. If there are no tapes in the tape library or VTS, then the TapeInfos is an empty array.

  • marker(Option<String>):

    A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.

• On failure, responds with SdkError<ListTapesError>

impl Client

pub fn list_volume_initiators(&self) -> ListVolumeInitiatorsFluentBuilder

Constructs a fluent builder for the ListVolumeInitiators operation.

• The fluent builder is configurable:
  • volume_arn(impl Into<String>) / set_volume_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.

    
    
• On success, responds with ListVolumeInitiatorsOutput with field(s):
  • initiators(Option<Vec::<String>>):

    The host names and port numbers of all iSCSI initiators that are connected to the gateway.

• On failure, responds with SdkError<ListVolumeInitiatorsError>

impl Client

pub fn list_volume_recovery_points( &self, ) -> ListVolumeRecoveryPointsFluentBuilder

Constructs a fluent builder for the ListVolumeRecoveryPoints operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with ListVolumeRecoveryPointsOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • volume_recovery_point_infos(Option<Vec::<VolumeRecoveryPointInfo>>):

    An array of VolumeRecoveryPointInfo objects.

• On failure, responds with SdkError<ListVolumeRecoveryPointsError>

impl Client

pub fn list_volumes(&self) -> ListVolumesFluentBuilder

Constructs a fluent builder for the ListVolumes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies that the list of volumes returned be limited to the specified number of items.

    
    
• On success, responds with ListVolumesOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • marker(Option<String>):

    Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.

  • volume_infos(Option<Vec::<VolumeInfo>>):

    An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array “[]”.

• On failure, responds with SdkError<ListVolumesError>

impl Client

pub fn notify_when_uploaded(&self) -> NotifyWhenUploadedFluentBuilder

Constructs a fluent builder for the NotifyWhenUploaded operation.

• The fluent builder is configurable:
  • file_share_arn(impl Into<String>) / set_file_share_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the file share.

    
    
• On success, responds with NotifyWhenUploadedOutput with field(s):
  • file_share_arn(Option<String>):

    The Amazon Resource Name (ARN) of the file share.

  • notification_id(Option<String>):

    The randomly generated ID of the notification that was sent. This ID is in UUID format.

• On failure, responds with SdkError<NotifyWhenUploadedError>

impl Client

pub fn refresh_cache(&self) -> RefreshCacheFluentBuilder

Constructs a fluent builder for the RefreshCache operation.

• The fluent builder is configurable:
  • file_share_arn(impl Into<String>) / set_file_share_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the file share you want to refresh.

    
    
  • folder_list(impl Into<String>) / set_folder_list(Option<Vec::<String>>):
    required: false
    

    A comma-separated list of the paths of folders to refresh in the cache. The default is [“/”]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that the file share has access to is refreshed.

    Do not include / when specifying folder names. For example, you would specify samplefolder rather than samplefolder/.

    
    
  • recursive(bool) / set_recursive(Option<bool>):
    required: false
    

    A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder’s contents. If this value set to true, each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is true.

    Valid Values: true | false

    
    
• On success, responds with RefreshCacheOutput with field(s):
  • file_share_arn(Option<String>):

    The Amazon Resource Name (ARN) of the file share.

  • notification_id(Option<String>):

    The randomly generated ID of the notification that was sent. This ID is in UUID format.

• On failure, responds with SdkError<RefreshCacheError>

impl Client

pub fn remove_tags_from_resource(&self) -> RemoveTagsFromResourceFluentBuilder

Constructs a fluent builder for the RemoveTagsFromResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource you want to remove the tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the tags you want to remove from the specified resource. A tag is composed of a key-value pair.

    
    
• On success, responds with RemoveTagsFromResourceOutput with field(s):
  • resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource that the tags were removed from.

• On failure, responds with SdkError<RemoveTagsFromResourceError>

impl Client

pub fn reset_cache(&self) -> ResetCacheFluentBuilder

Constructs a fluent builder for the ResetCache operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with ResetCacheOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<ResetCacheError>

impl Client

pub fn retrieve_tape_archive(&self) -> RetrieveTapeArchiveFluentBuilder

Constructs a fluent builder for the RetrieveTapeArchive operation.

• The fluent builder is configurable:
  • tape_arn(impl Into<String>) / set_tape_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).

    
    
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.

    
    
• On success, responds with RetrieveTapeArchiveOutput with field(s):
  • tape_arn(Option<String>):

    The Amazon Resource Name (ARN) of the retrieved virtual tape.

• On failure, responds with SdkError<RetrieveTapeArchiveError>

impl Client

pub fn retrieve_tape_recovery_point( &self, ) -> RetrieveTapeRecoveryPointFluentBuilder

Constructs a fluent builder for the RetrieveTapeRecoveryPoint operation.

• The fluent builder is configurable:
  • tape_arn(impl Into<String>) / set_tape_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.

    
    
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with RetrieveTapeRecoveryPointOutput with field(s):
  • tape_arn(Option<String>):

    The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.

• On failure, responds with SdkError<RetrieveTapeRecoveryPointError>

impl Client

pub fn set_local_console_password(&self) -> SetLocalConsolePasswordFluentBuilder

Constructs a fluent builder for the SetLocalConsolePassword operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • local_console_password(impl Into<String>) / set_local_console_password(Option<String>):
    required: true
    

    The password you want to set for your VM local console.

    
    
• On success, responds with SetLocalConsolePasswordOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<SetLocalConsolePasswordError>

impl Client

pub fn set_smb_guest_password(&self) -> SetSMBGuestPasswordFluentBuilder

Constructs a fluent builder for the SetSMBGuestPassword operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file share is associated with.

    
    
  • password(impl Into<String>) / set_password(Option<String>):
    required: true
    

    The password that you want to set for your SMB server.

    
    
• On success, responds with SetSmbGuestPasswordOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<SetSMBGuestPasswordError>

impl Client

pub fn shutdown_gateway(&self) -> ShutdownGatewayFluentBuilder

Constructs a fluent builder for the ShutdownGateway operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with ShutdownGatewayOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<ShutdownGatewayError>

impl Client

pub fn start_availability_monitor_test( &self, ) -> StartAvailabilityMonitorTestFluentBuilder

Constructs a fluent builder for the StartAvailabilityMonitorTest operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with StartAvailabilityMonitorTestOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<StartAvailabilityMonitorTestError>

impl Client

pub fn start_gateway(&self) -> StartGatewayFluentBuilder

Constructs a fluent builder for the StartGateway operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with StartGatewayOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<StartGatewayError>

impl Client

pub fn update_automatic_tape_creation_policy( &self, ) -> UpdateAutomaticTapeCreationPolicyFluentBuilder

Constructs a fluent builder for the UpdateAutomaticTapeCreationPolicy operation.

• The fluent builder is configurable:
  • automatic_tape_creation_rules(AutomaticTapeCreationRule) / set_automatic_tape_creation_rules(Option<Vec::<AutomaticTapeCreationRule>>):
    required: true
    

    An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.

    
    
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with UpdateAutomaticTapeCreationPolicyOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<UpdateAutomaticTapeCreationPolicyError>

impl Client

pub fn update_bandwidth_rate_limit( &self, ) -> UpdateBandwidthRateLimitFluentBuilder

Constructs a fluent builder for the UpdateBandwidthRateLimit operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • average_upload_rate_limit_in_bits_per_sec(i64) / set_average_upload_rate_limit_in_bits_per_sec(Option<i64>):
    required: false
    

    The average upload bandwidth rate limit in bits per second.

    
    
  • average_download_rate_limit_in_bits_per_sec(i64) / set_average_download_rate_limit_in_bits_per_sec(Option<i64>):
    required: false
    

    The average download bandwidth rate limit in bits per second.

    
    
• On success, responds with UpdateBandwidthRateLimitOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<UpdateBandwidthRateLimitError>

impl Client

pub fn update_bandwidth_rate_limit_schedule( &self, ) -> UpdateBandwidthRateLimitScheduleFluentBuilder

Constructs a fluent builder for the UpdateBandwidthRateLimitSchedule operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • bandwidth_rate_limit_intervals(BandwidthRateLimitInterval) / set_bandwidth_rate_limit_intervals(Option<Vec::<BandwidthRateLimitInterval>>):
    required: true
    

    An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

    
    
• On success, responds with UpdateBandwidthRateLimitScheduleOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<UpdateBandwidthRateLimitScheduleError>

impl Client

pub fn update_chap_credentials(&self) -> UpdateChapCredentialsFluentBuilder

Constructs a fluent builder for the UpdateChapCredentials operation.

• The fluent builder is configurable:
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.

    
    
  • secret_to_authenticate_initiator(impl Into<String>) / set_secret_to_authenticate_initiator(Option<String>):
    required: true
    

    The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

    The secret key must be between 12 and 16 bytes when encoded in UTF-8.

    
    
  • initiator_name(impl Into<String>) / set_initiator_name(Option<String>):
    required: true
    

    The iSCSI initiator that connects to the target.

    
    
  • secret_to_authenticate_target(impl Into<String>) / set_secret_to_authenticate_target(Option<String>):
    required: false
    

    The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

    Byte constraints: Minimum bytes of 12. Maximum bytes of 16.

    The secret key must be between 12 and 16 bytes when encoded in UTF-8.

    
    
• On success, responds with UpdateChapCredentialsOutput with field(s):
  • target_arn(Option<String>):

    The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.

  • initiator_name(Option<String>):

    The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.

• On failure, responds with SdkError<UpdateChapCredentialsError>

impl Client

pub fn update_file_system_association( &self, ) -> UpdateFileSystemAssociationFluentBuilder

Constructs a fluent builder for the UpdateFileSystemAssociation operation.

• The fluent builder is configurable:
  • file_system_association_arn(impl Into<String>) / set_file_system_association_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the file system association that you want to update.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: false
    

    The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

    
    
  • password(impl Into<String>) / set_password(Option<String>):
    required: false
    

    The password of the user credential.

    
    
  • audit_destination_arn(impl Into<String>) / set_audit_destination_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the storage used for the audit logs.

    
    
  • cache_attributes(CacheAttributes) / set_cache_attributes(Option<CacheAttributes>):
    required: false
    

    The refresh cache information for the file share or FSx file systems.

    
    
• On success, responds with UpdateFileSystemAssociationOutput with field(s):
  • file_system_association_arn(Option<String>):

    The ARN of the updated file system association.

• On failure, responds with SdkError<UpdateFileSystemAssociationError>

impl Client

pub fn update_gateway_information( &self, ) -> UpdateGatewayInformationFluentBuilder

Constructs a fluent builder for the UpdateGatewayInformation operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • gateway_name(impl Into<String>) / set_gateway_name(Option<String>):
    required: false
    

    The name you configured for your gateway.

    
    
  • gateway_timezone(impl Into<String>) / set_gateway_timezone(Option<String>):
    required: false
    

    A value that indicates the time zone of the gateway.

    
    
  • cloud_watch_log_group_arn(impl Into<String>) / set_cloud_watch_log_group_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.

    For more information, see What is Amazon CloudWatch Logs?

    
    
  • gateway_capacity(GatewayCapacity) / set_gateway_capacity(Option<GatewayCapacity>):
    required: false
    

    Specifies the size of the gateway’s metadata cache. This setting impacts gateway performance and hardware recommendations. For more information, see Performance guidance for gateways with multiple file shares in the Amazon S3 File Gateway User Guide.

    
    
• On success, responds with UpdateGatewayInformationOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • gateway_name(Option<String>):

    The name you configured for your gateway.

• On failure, responds with SdkError<UpdateGatewayInformationError>

impl Client

pub fn update_gateway_software_now( &self, ) -> UpdateGatewaySoftwareNowFluentBuilder

Constructs a fluent builder for the UpdateGatewaySoftwareNow operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
• On success, responds with UpdateGatewaySoftwareNowOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<UpdateGatewaySoftwareNowError>

impl Client

pub fn update_maintenance_start_time( &self, ) -> UpdateMaintenanceStartTimeFluentBuilder

Constructs a fluent builder for the UpdateMaintenanceStartTime operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • hour_of_day(i32) / set_hour_of_day(Option<i32>):
    required: false
    

    The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.

    
    
  • minute_of_hour(i32) / set_minute_of_hour(Option<i32>):
    required: false
    

    The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.

    
    
  • day_of_week(i32) / set_day_of_week(Option<i32>):
    required: false
    

    The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

    
    
  • day_of_month(i32) / set_day_of_month(Option<i32>):
    required: false
    

    The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month. It is not possible to set the maintenance schedule to start on days 29 through 31.

    
    
  • software_update_preferences(SoftwareUpdatePreferences) / set_software_update_preferences(Option<SoftwareUpdatePreferences>):
    required: false
    

    A set of variables indicating the software update preferences for the gateway.

    Includes AutomaticUpdatePolicy field with the following inputs:

    ALL_VERSIONS - Enables regular gateway maintenance updates.

    EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.

    
    
• On success, responds with UpdateMaintenanceStartTimeOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<UpdateMaintenanceStartTimeError>

impl Client

pub fn update_nfs_file_share(&self) -> UpdateNFSFileShareFluentBuilder

Constructs a fluent builder for the UpdateNFSFileShare operation.

• The fluent builder is configurable:
  • file_share_arn(impl Into<String>) / set_file_share_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the file share to be updated.

    
    
  • kms_encrypted(bool) / set_kms_encrypted(Option<bool>):
    required: false
    

    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

    Valid Values: true | false

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    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 value can only be set when KMSEncrypted is true. Optional.

    
    
  • nfs_file_share_defaults(NfsFileShareDefaults) / set_nfs_file_share_defaults(Option<NfsFileShareDefaults>):
    required: false
    

    The default values for the file share. Optional.

    
    
  • default_storage_class(impl Into<String>) / set_default_storage_class(Option<String>):
    required: false
    

    The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

    
    
  • object_acl(ObjectAcl) / set_object_acl(Option<ObjectAcl>):
    required: false
    

    A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.

    
    
  • client_list(impl Into<String>) / set_client_list(Option<Vec::<String>>):
    required: false
    

    The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.

    
    
  • squash(impl Into<String>) / set_squash(Option<String>):
    required: false
    

    The user mapped to anonymous user.

    Valid values are the following:

    • RootSquash: Only root is mapped to anonymous user.

    • NoSquash: No one is mapped to anonymous user.

    • AllSquash: Everyone is mapped to anonymous user.

    
    
  • read_only(bool) / set_read_only(Option<bool>):
    required: false
    

    A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

    Valid Values: true | false

    
    
  • guess_mime_type_enabled(bool) / set_guess_mime_type_enabled(Option<bool>):
    required: false
    

    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

    Valid Values: true | false

    
    
  • requester_pays(bool) / set_requester_pays(Option<bool>):
    required: false
    

    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

    Valid Values: true | false

    
    
  • file_share_name(impl Into<String>) / set_file_share_name(Option<String>):
    required: false
    

    The name of the file share. Optional.

    FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.

    
    
  • cache_attributes(CacheAttributes) / set_cache_attributes(Option<CacheAttributes>):
    required: false
    

    Specifies refresh cache information for the file share.

    
    
  • notification_policy(impl Into<String>) / set_notification_policy(Option<String>):
    required: false
    

    The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it’s best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

    SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

    The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

    {"Upload": {"SettlingTimeInSeconds": 60}}

    The following example sets NotificationPolicy off.

    {}

    
    
  • audit_destination_arn(impl Into<String>) / set_audit_destination_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the storage used for audit logs.

    
    
• On success, responds with UpdateNfsFileShareOutput with field(s):
  • file_share_arn(Option<String>):

    The Amazon Resource Name (ARN) of the updated file share.

• On failure, responds with SdkError<UpdateNFSFileShareError>

impl Client

pub fn update_smb_file_share(&self) -> UpdateSMBFileShareFluentBuilder

Constructs a fluent builder for the UpdateSMBFileShare operation.

• The fluent builder is configurable:
  • file_share_arn(impl Into<String>) / set_file_share_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the SMB file share that you want to update.

    
    
  • kms_encrypted(bool) / set_kms_encrypted(Option<bool>):
    required: false
    

    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

    Valid Values: true | false

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    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 value can only be set when KMSEncrypted is true. Optional.

    
    
  • default_storage_class(impl Into<String>) / set_default_storage_class(Option<String>):
    required: false
    

    The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

    
    
  • object_acl(ObjectAcl) / set_object_acl(Option<ObjectAcl>):
    required: false
    

    A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.

    
    
  • read_only(bool) / set_read_only(Option<bool>):
    required: false
    

    A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false.

    Valid Values: true | false

    
    
  • guess_mime_type_enabled(bool) / set_guess_mime_type_enabled(Option<bool>):
    required: false
    

    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

    Valid Values: true | false

    
    
  • requester_pays(bool) / set_requester_pays(Option<bool>):
    required: false
    

    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

    Valid Values: true | false

    
    
  • smbacl_enabled(bool) / set_smbacl_enabled(Option<bool>):
    required: false
    

    Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.

    For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

    Valid Values: true | false

    
    
  • access_based_enumeration(bool) / set_access_based_enumeration(Option<bool>):
    required: false
    

    The files and folders on this share will only be visible to users with read access.

    
    
  • admin_user_list(impl Into<String>) / set_admin_user_list(Option<Vec::<String>>):
    required: false
    

    A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

    
    
  • valid_user_list(impl Into<String>) / set_valid_user_list(Option<Vec::<String>>):
    required: false
    

    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

    
    
  • invalid_user_list(impl Into<String>) / set_invalid_user_list(Option<Vec::<String>>):
    required: false
    

    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

    
    
  • audit_destination_arn(impl Into<String>) / set_audit_destination_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the storage used for audit logs.

    
    
  • case_sensitivity(CaseSensitivity) / set_case_sensitivity(Option<CaseSensitivity>):
    required: false
    

    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

    
    
  • file_share_name(impl Into<String>) / set_file_share_name(Option<String>):
    required: false
    

    The name of the file share. Optional.

    FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.

    
    
  • cache_attributes(CacheAttributes) / set_cache_attributes(Option<CacheAttributes>):
    required: false
    

    Specifies refresh cache information for the file share.

    
    
  • notification_policy(impl Into<String>) / set_notification_policy(Option<String>):
    required: false
    

    The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it’s best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

    SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

    The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

    {"Upload": {"SettlingTimeInSeconds": 60}}

    The following example sets NotificationPolicy off.

    {}

    
    
  • oplocks_enabled(bool) / set_oplocks_enabled(Option<bool>):
    required: false
    

    Specifies whether opportunistic locking is enabled for the SMB file share.

    Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.

    Valid Values: true | false

    
    
• On success, responds with UpdateSmbFileShareOutput with field(s):
  • file_share_arn(Option<String>):

    The Amazon Resource Name (ARN) of the updated SMB file share.

• On failure, responds with SdkError<UpdateSMBFileShareError>

impl Client

pub fn update_smb_file_share_visibility( &self, ) -> UpdateSMBFileShareVisibilityFluentBuilder

Constructs a fluent builder for the UpdateSMBFileShareVisibility operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • file_shares_visible(bool) / set_file_shares_visible(Option<bool>):
    required: true
    

    The shares on this gateway appear when listing shares.

    
    
• On success, responds with UpdateSmbFileShareVisibilityOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<UpdateSMBFileShareVisibilityError>

impl Client

pub fn update_smb_local_groups(&self) -> UpdateSMBLocalGroupsFluentBuilder

Constructs a fluent builder for the UpdateSMBLocalGroups operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • smb_local_groups(SmbLocalGroups) / set_smb_local_groups(Option<SmbLocalGroups>):
    required: true
    

    A list of Active Directory users and groups that you want to grant special permissions for SMB file shares on the gateway.

    
    
• On success, responds with UpdateSmbLocalGroupsOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<UpdateSMBLocalGroupsError>

impl Client

pub fn update_smb_security_strategy( &self, ) -> UpdateSMBSecurityStrategyFluentBuilder

Constructs a fluent builder for the UpdateSMBSecurityStrategy operation.

• The fluent builder is configurable:
  • gateway_arn(impl Into<String>) / set_gateway_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    
    
  • smb_security_strategy(SmbSecurityStrategy) / set_smb_security_strategy(Option<SmbSecurityStrategy>):
    required: true
    

    Specifies the type of security strategy.

    ClientSpecified: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway.

    MandatorySigning: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

    MandatoryEncryption: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption enabled. This option is recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

    MandatoryEncryptionNoAes128: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.

    
    
• On success, responds with UpdateSmbSecurityStrategyOutput with field(s):
  • gateway_arn(Option<String>):

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• On failure, responds with SdkError<UpdateSMBSecurityStrategyError>

impl Client

pub fn update_snapshot_schedule(&self) -> UpdateSnapshotScheduleFluentBuilder

Constructs a fluent builder for the UpdateSnapshotSchedule operation.

• The fluent builder is configurable:
  • volume_arn(impl Into<String>) / set_volume_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    
    
  • start_at(i32) / set_start_at(Option<i32>):
    required: true
    

    The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

    
    
  • recurrence_in_hours(i32) / set_recurrence_in_hours(Option<i32>):
    required: true
    

    Frequency of snapshots. Specify the number of hours between snapshots.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Optional description of the snapshot that overwrites the existing description.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256.

    
    
• On success, responds with UpdateSnapshotScheduleOutput with field(s):
  • volume_arn(Option<String>):

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

• On failure, responds with SdkError<UpdateSnapshotScheduleError>

impl Client

pub fn update_vtl_device_type(&self) -> UpdateVTLDeviceTypeFluentBuilder

Constructs a fluent builder for the UpdateVTLDeviceType operation.

• The fluent builder is configurable:
  • vtl_device_arn(impl Into<String>) / set_vtl_device_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the medium changer you want to select.

    
    
  • device_type(impl Into<String>) / set_device_type(Option<String>):
    required: true
    

    The type of medium changer you want to select.

    Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

    
    
• On success, responds with UpdateVtlDeviceTypeOutput with field(s):
  • vtl_device_arn(Option<String>):

    The Amazon Resource Name (ARN) of the medium changer you have selected.

• On failure, responds with SdkError<UpdateVTLDeviceTypeError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.