Class: Aws::S3Files::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb

Overview

An API client for S3Files. To construct a client, you need to configure a :region and :credentials.

client = Aws::S3Files::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::S3Files::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::S3Files::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#create_access_point(params = {}) ⇒ Types::CreateAccessPointResponse

Creates an S3 File System Access Point for application-specific access with POSIX user identity and root directory enforcement. Access points provide a way to manage access to shared datasets in multi-tenant scenarios.

Examples:

Request syntax with placeholder values


resp = client.create_access_point({
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  file_system_id: "FileSystemId", # required
  posix_user: {
    uid: 1, # required
    gid: 1, # required
    secondary_gids: [1],
  },
  root_directory: {
    path: "Path",
    creation_permissions: {
      owner_uid: 1, # required
      owner_gid: 1, # required
      permissions: "Permissions", # required
    },
  },
})

Response structure


resp.access_point_arn #=> String
resp.access_point_id #=> String
resp.client_token #=> String
resp.file_system_id #=> String
resp.status #=> String, one of "available", "creating", "deleting", "deleted", "error", "updating"
resp.owner_id #=> String
resp.posix_user.uid #=> Integer
resp.posix_user.gid #=> Integer
resp.posix_user.secondary_gids #=> Array
resp.posix_user.secondary_gids[0] #=> Integer
resp.root_directory.path #=> String
resp.root_directory.creation_permissions.owner_uid #=> Integer
resp.root_directory.creation_permissions.owner_gid #=> Integer
resp.root_directory.creation_permissions.permissions #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Web Services ignores the request, but does not return an error.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Array<Types::Tag>) —

    An array of key-value pairs to apply to the access point for resource tagging.

  • :file_system_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the S3 File System.

  • :posix_user (Types::PosixUser) —

    The POSIX identity with uid, gid, and secondary group IDs for user enforcement when accessing the file system through this access point.

  • :root_directory (Types::RootDirectory) —

    The root directory path for the access point, with optional creation permissions for newly created directories.

Returns:

See Also:



570
571
572
573
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 570

def create_access_point(params = {}, options = {})
  req = build_request(:create_access_point, params)
  req.send_request(options)
end

#create_file_system(params = {}) ⇒ Types::CreateFileSystemResponse

Creates an S3 File System resource scoped to a bucket or prefix within a bucket, enabling file system access to S3 data. To create a file system, you need an S3 bucket and an IAM role that grants the service permission to access the bucket.

Examples:

Request syntax with placeholder values


resp = client.create_file_system({
  bucket: "BucketArn", # required
  prefix: "CreateFileSystemRequestPrefixString",
  client_token: "CreationToken",
  kms_key_id: "KmsKeyId",
  role_arn: "RoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  accept_bucket_warning: false,
})

Response structure


resp.creation_time #=> Time
resp.file_system_arn #=> String
resp.file_system_id #=> String
resp.bucket #=> String
resp.prefix #=> String
resp.client_token #=> String
resp.kms_key_id #=> String
resp.status #=> String, one of "available", "creating", "deleting", "deleted", "error", "updating"
resp.status_message #=> String
resp.role_arn #=> String
resp.owner_id #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The Amazon Resource Name (ARN) of the S3 bucket that will be accessible through the file system. The bucket must exist and be in the same Amazon Web Services Region as the file system.

  • :prefix (String) —

    An optional prefix within the S3 bucket to scope the file system access. If specified, the file system provides access only to objects with keys that begin with this prefix. If not specified, the file system provides access to the entire bucket.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure idempotent creation. Up to 64 ASCII characters are allowed. If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :kms_key_id (String) —

    The ARN, key ID, or alias of the KMS key to use for encryption. If not specified, the service uses a service-owned key for encryption. You can specify a KMS key using the following formats: key ID, ARN, key alias, or key alias ARN. If you use KmsKeyId, the file system will be encrypted.

  • :role_arn (required, String) —

    The ARN of the IAM role that grants the S3 Files service permission to read and write data between the file system and the S3 bucket. This role must have the necessary permissions to access the specified bucket and prefix.

  • :tags (Array<Types::Tag>) —

    An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource.

  • :accept_bucket_warning (Boolean) —

    Set to true to acknowledge and accept any warnings about the bucket configuration. If not specified, the operation may fail if there are bucket configuration warnings.

Returns:

See Also:



679
680
681
682
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 679

def create_file_system(params = {}, options = {})
  req = build_request(:create_file_system, params)
  req.send_request(options)
end

#create_mount_target(params = {}) ⇒ Types::CreateMountTargetResponse

Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in a specific Availability Zone and VPC. Mount targets provide network access to the file system.

Examples:

Request syntax with placeholder values


resp = client.create_mount_target({
  file_system_id: "FileSystemId", # required
  subnet_id: "SubnetId", # required
  ipv4_address: "Ipv4Address",
  ipv6_address: "Ipv6Address",
  ip_address_type: "IPV4_ONLY", # accepts IPV4_ONLY, IPV6_ONLY, DUAL_STACK
  security_groups: ["SecurityGroup"],
})

Response structure


resp.availability_zone_id #=> String
resp.owner_id #=> String
resp.mount_target_id #=> String
resp.file_system_id #=> String
resp.subnet_id #=> String
resp.ipv4_address #=> String
resp.ipv6_address #=> String
resp.network_interface_id #=> String
resp.vpc_id #=> String
resp.security_groups #=> Array
resp.security_groups[0] #=> String
resp.status #=> String, one of "available", "creating", "deleting", "deleted", "error", "updating"
resp.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the S3 File System to create the mount target for.

  • :subnet_id (required, String) —

    The ID of the subnet where the mount target will be created. The subnet must be in the same Amazon Web Services Region as the file system. For file systems with regional availability, you can create mount targets in any subnet within the Region. The subnet determines the Availability Zone where the mount target will be located.

  • :ipv4_address (String) —

    A specific IPv4 address to assign to the mount target. If not specified and the IP address type supports IPv4, an address is automatically assigned from the subnet's available IPv4 address range. The address must be within the subnet's CIDR block and not already in use.

  • :ipv6_address (String) —

    A specific IPv6 address to assign to the mount target. If not specified and the IP address type supports IPv6, an address is automatically assigned from the subnet's available IPv6 address range. The address must be within the subnet's IPv6 CIDR block and not already in use.

  • :ip_address_type (String) —

    The IP address type for the mount target. If not specified, IPV4_ONLY is used. The IP address type must match the IP configuration of the specified subnet.

  • :security_groups (Array<String>) —

    An array of VPC security group IDs to associate with the mount target's network interface. These security groups control network access to the mount target. If not specified, the default security group for the subnet's VPC is used. All security groups must belong to the same VPC as the subnet.

Returns:

See Also:



771
772
773
774
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 771

def create_mount_target(params = {}, options = {})
  req = build_request(:create_mount_target, params)
  req.send_request(options)
end

#delete_access_point(params = {}) ⇒ Struct

Deletes an S3 File System Access Point. This operation is irreversible.

Examples:

Request syntax with placeholder values


resp = client.delete_access_point({
  access_point_id: "AccessPointId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :access_point_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the access point to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



794
795
796
797
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 794

def delete_access_point(params = {}, options = {})
  req = build_request(:delete_access_point, params)
  req.send_request(options)
end

#delete_file_system(params = {}) ⇒ Struct

Deletes an S3 File System. You can optionally force deletion of a file system that has pending export data.

Examples:

Request syntax with placeholder values


resp = client.delete_file_system({
  file_system_id: "FileSystemId", # required
  force_delete: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the S3 File System to delete.

  • :force_delete (Boolean) —

    If true, allows deletion of a file system that contains data pending export to S3. If false (the default), the deletion will fail if there is data that has not yet been exported to the S3 bucket. Use this parameter with caution as it may result in data loss.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



824
825
826
827
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 824

def delete_file_system(params = {}, options = {})
  req = build_request(:delete_file_system, params)
  req.send_request(options)
end

#delete_file_system_policy(params = {}) ⇒ Struct

Deletes the IAM resource policy of an S3 File System.

Examples:

Request syntax with placeholder values


resp = client.delete_file_system_policy({
  file_system_id: "FileSystemId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the S3 File System whose resource policy to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



847
848
849
850
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 847

def delete_file_system_policy(params = {}, options = {})
  req = build_request(:delete_file_system_policy, params)
  req.send_request(options)
end

#delete_mount_target(params = {}) ⇒ Struct

Deletes the specified mount target. This operation is irreversible.

Examples:

Request syntax with placeholder values


resp = client.delete_mount_target({
  mount_target_id: "MountTargetId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mount_target_id (required, String) —

    The ID of the mount target to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



869
870
871
872
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 869

def delete_mount_target(params = {}, options = {})
  req = build_request(:delete_mount_target, params)
  req.send_request(options)
end

#get_access_point(params = {}) ⇒ Types::GetAccessPointResponse

Returns resource information for an S3 File System Access Point.

Examples:

Request syntax with placeholder values


resp = client.get_access_point({
  access_point_id: "AccessPointId", # required
})

Response structure


resp.access_point_arn #=> String
resp.access_point_id #=> String
resp.client_token #=> String
resp.file_system_id #=> String
resp.status #=> String, one of "available", "creating", "deleting", "deleted", "error", "updating"
resp.owner_id #=> String
resp.posix_user.uid #=> Integer
resp.posix_user.gid #=> Integer
resp.posix_user.secondary_gids #=> Array
resp.posix_user.secondary_gids[0] #=> Integer
resp.root_directory.path #=> String
resp.root_directory.creation_permissions.owner_uid #=> Integer
resp.root_directory.creation_permissions.owner_gid #=> Integer
resp.root_directory.creation_permissions.permissions #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :access_point_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the access point to retrieve information for.

Returns:

See Also:



924
925
926
927
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 924

def get_access_point(params = {}, options = {})
  req = build_request(:get_access_point, params)
  req.send_request(options)
end

#get_file_system(params = {}) ⇒ Types::GetFileSystemResponse

Returns resource information for the specified S3 File System including status, configuration, and metadata.

Examples:

Request syntax with placeholder values


resp = client.get_file_system({
  file_system_id: "FileSystemId", # required
})

Response structure


resp.creation_time #=> Time
resp.file_system_arn #=> String
resp.file_system_id #=> String
resp.bucket #=> String
resp.prefix #=> String
resp.client_token #=> String
resp.kms_key_id #=> String
resp.status #=> String, one of "available", "creating", "deleting", "deleted", "error", "updating"
resp.status_message #=> String
resp.role_arn #=> String
resp.owner_id #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the S3 File System to retrieve information for.

Returns:

See Also:



980
981
982
983
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 980

def get_file_system(params = {}, options = {})
  req = build_request(:get_file_system, params)
  req.send_request(options)
end

#get_file_system_policy(params = {}) ⇒ Types::GetFileSystemPolicyResponse

Returns the IAM resource policy of an S3 File System.

Examples:

Request syntax with placeholder values


resp = client.get_file_system_policy({
  file_system_id: "FileSystemId", # required
})

Response structure


resp.file_system_id #=> String
resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the S3 File System whose resource policy to retrieve.

Returns:

See Also:



1011
1012
1013
1014
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1011

def get_file_system_policy(params = {}, options = {})
  req = build_request(:get_file_system_policy, params)
  req.send_request(options)
end

#get_mount_target(params = {}) ⇒ Types::GetMountTargetResponse

Returns detailed resource information for the specified mount target including network configuration.

Examples:

Request syntax with placeholder values


resp = client.get_mount_target({
  mount_target_id: "MountTargetId", # required
})

Response structure


resp.availability_zone_id #=> String
resp.owner_id #=> String
resp.mount_target_id #=> String
resp.file_system_id #=> String
resp.subnet_id #=> String
resp.ipv4_address #=> String
resp.ipv6_address #=> String
resp.network_interface_id #=> String
resp.vpc_id #=> String
resp.security_groups #=> Array
resp.security_groups[0] #=> String
resp.status #=> String, one of "available", "creating", "deleting", "deleted", "error", "updating"
resp.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mount_target_id (required, String) —

    The ID of the mount target to retrieve information for.

Returns:

See Also:



1063
1064
1065
1066
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1063

def get_mount_target(params = {}, options = {})
  req = build_request(:get_mount_target, params)
  req.send_request(options)
end

#get_synchronization_configuration(params = {}) ⇒ Types::GetSynchronizationConfigurationResponse

Returns the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

Examples:

Request syntax with placeholder values


resp = client.get_synchronization_configuration({
  file_system_id: "FileSystemId", # required
})

Response structure


resp.latest_version_number #=> Integer
resp.import_data_rules #=> Array
resp.import_data_rules[0].prefix #=> String
resp.import_data_rules[0].trigger #=> String, one of "ON_DIRECTORY_FIRST_ACCESS", "ON_FILE_ACCESS"
resp.import_data_rules[0].size_less_than #=> Integer
resp.expiration_data_rules #=> Array
resp.expiration_data_rules[0].days_after_last_access #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the S3 File System to retrieve the synchronization configuration for.

Returns:

See Also:



1101
1102
1103
1104
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1101

def get_synchronization_configuration(params = {}, options = {})
  req = build_request(:get_synchronization_configuration, params)
  req.send_request(options)
end

#list_access_points(params = {}) ⇒ Types::ListAccessPointsResponse

Returns resource information for all S3 File System Access Points associated with the specified S3 File System.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_access_points({
  file_system_id: "FileSystemId", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.access_points #=> Array
resp.access_points[0].access_point_arn #=> String
resp.access_points[0].access_point_id #=> String
resp.access_points[0].file_system_id #=> String
resp.access_points[0].status #=> String, one of "available", "creating", "deleting", "deleted", "error", "updating"
resp.access_points[0].owner_id #=> String
resp.access_points[0].posix_user.uid #=> Integer
resp.access_points[0].posix_user.gid #=> Integer
resp.access_points[0].posix_user.secondary_gids #=> Array
resp.access_points[0].posix_user.secondary_gids[0] #=> Integer
resp.access_points[0].root_directory.path #=> String
resp.access_points[0].root_directory.creation_permissions.owner_uid #=> Integer
resp.access_points[0].root_directory.creation_permissions.owner_gid #=> Integer
resp.access_points[0].root_directory.creation_permissions.permissions #=> String
resp.access_points[0].name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the S3 File System to list access points for.

  • :max_results (Integer) —

    The maximum number of access points to return in a single response.

  • :next_token (String) —

    A pagination token returned from a previous call to continue listing access points.

Returns:

See Also:



1158
1159
1160
1161
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1158

def list_access_points(params = {}, options = {})
  req = build_request(:list_access_points, params)
  req.send_request(options)
end

#list_file_systems(params = {}) ⇒ Types::ListFileSystemsResponse

Returns a list of all S3 File Systems owned by the account with optional filtering by bucket.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_file_systems({
  bucket: "BucketArn",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.file_systems #=> Array
resp.file_systems[0].creation_time #=> Time
resp.file_systems[0].file_system_arn #=> String
resp.file_systems[0].file_system_id #=> String
resp.file_systems[0].name #=> String
resp.file_systems[0].bucket #=> String
resp.file_systems[0].status #=> String, one of "available", "creating", "deleting", "deleted", "error", "updating"
resp.file_systems[0].status_message #=> String
resp.file_systems[0].role_arn #=> String
resp.file_systems[0].owner_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (String) —

    Optional filter to list only file systems associated with the specified S3 bucket Amazon Resource Name (ARN). If provided, only file systems that provide access to this bucket will be returned in the response.

  • :max_results (Integer) —

    The maximum number of file systems to return in a single response. If not specified, up to 100 file systems are returned.

  • :next_token (String) —

    A pagination token returned from a previous call to continue listing file systems.

Returns:

See Also:



1213
1214
1215
1216
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1213

def list_file_systems(params = {}, options = {})
  req = build_request(:list_file_systems, params)
  req.send_request(options)
end

#list_mount_targets(params = {}) ⇒ Types::ListMountTargetsResponse

Returns resource information for all mount targets with optional filtering by file system, access point, and VPC.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_mount_targets({
  file_system_id: "FileSystemId",
  access_point_id: "AccessPointId",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.mount_targets #=> Array
resp.mount_targets[0].availability_zone_id #=> String
resp.mount_targets[0].file_system_id #=> String
resp.mount_targets[0].ipv4_address #=> String
resp.mount_targets[0].ipv6_address #=> String
resp.mount_targets[0].status #=> String, one of "available", "creating", "deleting", "deleted", "error", "updating"
resp.mount_targets[0].status_message #=> String
resp.mount_targets[0].mount_target_id #=> String
resp.mount_targets[0].network_interface_id #=> String
resp.mount_targets[0].owner_id #=> String
resp.mount_targets[0].subnet_id #=> String
resp.mount_targets[0].vpc_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (String) —

    Optional filter to list only mount targets associated with the specified S3 File System ID or Amazon Resource Name (ARN). If provided, only mount targets for this file system will be returned in the response.

  • :access_point_id (String) —

    Optional filter to list only mount targets associated with the specified access point ID or Amazon Resource Name (ARN).

  • :max_results (Integer) —

    The maximum number of mount targets to return in a single response.

  • :next_token (String) —

    A pagination token returned from a previous call to continue listing mount targets.

Returns:

See Also:



1274
1275
1276
1277
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1274

def list_mount_targets(params = {}, options = {})
  req = build_request(:list_mount_targets, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags for S3 Files resources.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_id: "ResourceId", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the resource to list tags for.

  • :max_results (Integer) —

    The maximum number of tags to return in a single response.

  • :next_token (String) —

    A pagination token returned from a previous call to continue listing tags.

Returns:

See Also:



1317
1318
1319
1320
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1317

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_file_system_policy(params = {}) ⇒ Struct

Creates or replaces the IAM resource policy for an S3 File System to control access permissions.

Examples:

Request syntax with placeholder values


resp = client.put_file_system_policy({
  file_system_id: "FileSystemId", # required
  policy: "String", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the S3 File System to apply the resource policy to.

  • :policy (required, String) —

    The JSON-formatted resource policy to apply to the file system. The policy defines the permissions for accessing the file system. The policy must be a valid JSON document that follows IAM policy syntax.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1347
1348
1349
1350
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1347

def put_file_system_policy(params = {}, options = {})
  req = build_request(:put_file_system_policy, params)
  req.send_request(options)
end

#put_synchronization_configuration(params = {}) ⇒ Struct

Creates or updates the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

Examples:

Request syntax with placeholder values


resp = client.put_synchronization_configuration({
  file_system_id: "FileSystemId", # required
  latest_version_number: 1,
  import_data_rules: [ # required
    {
      prefix: "ImportDataRulePrefixString", # required
      trigger: "ON_DIRECTORY_FIRST_ACCESS", # required, accepts ON_DIRECTORY_FIRST_ACCESS, ON_FILE_ACCESS
      size_less_than: 1, # required
    },
  ],
  expiration_data_rules: [ # required
    {
      days_after_last_access: 1, # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the S3 File System to configure synchronization for.

  • :latest_version_number (Integer) —

    The version number of the current synchronization configuration. Omit this value when creating a synchronization configuration for the first time. For subsequent updates, provide this value for optimistic concurrency control. If the version number does not match the current configuration, the request fails with a ConflictException.

  • :import_data_rules (required, Array<Types::ImportDataRule>) —

    An array of import data rules that control how data is imported from S3 into the file system.

  • :expiration_data_rules (required, Array<Types::ExpirationDataRule>) —

    An array of expiration data rules that control when cached data expires from the file system.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1399
1400
1401
1402
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1399

def put_synchronization_configuration(params = {}, options = {})
  req = build_request(:put_synchronization_configuration, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Creates tags for S3 Files resources using standard Amazon Web Services tagging APIs.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_id: "ResourceId", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the resource to add tags to.

  • :tags (required, Array<Types::Tag>) —

    An array of key-value pairs to add as tags to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1431
1432
1433
1434
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1431

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from S3 Files resources.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_id: "ResourceId", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The ID or Amazon Resource Name (ARN) of the resource to remove tags from.

  • :tag_keys (required, Array<String>) —

    An array of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1458
1459
1460
1461
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1458

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_mount_target(params = {}) ⇒ Types::UpdateMountTargetResponse

Updates the mount target resource, specifically security group configurations.

Examples:

Request syntax with placeholder values


resp = client.update_mount_target({
  mount_target_id: "MountTargetId", # required
  security_groups: ["SecurityGroup"], # required
})

Response structure


resp.availability_zone_id #=> String
resp.owner_id #=> String
resp.mount_target_id #=> String
resp.file_system_id #=> String
resp.subnet_id #=> String
resp.ipv4_address #=> String
resp.ipv6_address #=> String
resp.network_interface_id #=> String
resp.vpc_id #=> String
resp.security_groups #=> Array
resp.security_groups[0] #=> String
resp.status #=> String, one of "available", "creating", "deleting", "deleted", "error", "updating"
resp.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mount_target_id (required, String) —

    The ID of the mount target to update.

  • :security_groups (required, Array<String>) —

    An array of VPC security group IDs to associate with the mount target's network interface. This replaces the existing security groups. All security groups must belong to the same VPC as the mount target's subnet.

Returns:

See Also:



1517
1518
1519
1520
 
# File 'gems/aws-sdk-s3files/lib/aws-sdk-s3files/client.rb', line 1517

def update_mount_target(params = {}, options = {})
  req = build_request(:update_mount_target, params)
  req.send_request(options)
end