Class: Aws::S3Control::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-s3control/client.rb

Overview

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

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

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`

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

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.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` 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:

  • :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` 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 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 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` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :s3_use_arn_region (Boolean) — default: true —

    For S3 and S3 Outposts ARNs passed into the ‘:bucket` or `:name` parameter, this option will use the region in the ARN, allowing for cross-region requests to be made. Set to `false` to use the client’s region instead.

  • :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:

  • :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::S3Control::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::S3Control::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 ‘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.



485
486
487
 
# File 'lib/aws-sdk-s3control/client.rb', line 485

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



8220
8221
8222
 
# File 'lib/aws-sdk-s3control/client.rb', line 8220

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



8223
8224
8225
 
# File 'lib/aws-sdk-s3control/client.rb', line 8223

def errors_module
  Errors
end

Instance Method Details

#associate_access_grants_identity_center(params = {}) ⇒ Struct

Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance. Use this action if you want to create access grants for users or groups from your corporate identity directory. First, you must add your corporate identity directory to Amazon Web Services IAM Identity Center. Then, you can associate this IAM Identity Center instance with your S3 Access Grants instance.

Permissions

: You must have the ‘s3:AssociateAccessGrantsIdentityCenter`

permission to use this operation.

Additional Permissions

: You must also have the following permissions:

`sso:CreateApplication`, `sso:PutApplicationGrant`, and
`sso:PutApplicationAuthenticationMethod`.

Examples:

Request syntax with placeholder values


resp = client.associate_access_grants_identity_center({
  account_id: "AccountId",
  identity_center_arn: "IdentityCenterArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :identity_center_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the

    ListInstances][1

    API operation to retrieve a list of your Identity

    Center instances and their ARNs.

    [1]: docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListInstances.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



537
538
539
540
 
# File 'lib/aws-sdk-s3control/client.rb', line 537

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
 
# File 'lib/aws-sdk-s3control/client.rb', line 8193

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::S3Control')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-s3control'
  context[:gem_version] = '1.122.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_access_grant(params = {}) ⇒ Types::CreateAccessGrantResult

Creates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the [CreateAccessGrantsInstance]. You must also have registered at least one S3 data location in your S3 Access Grants instance using [CreateAccessGrantsLocation].

Permissions

: You must have the ‘s3:CreateAccessGrant` permission to use this

operation.

Additional Permissions

: For any directory identity - ‘sso:DescribeInstance` and

`sso:DescribeApplication`

For directory users - `identitystore:DescribeUser`

For directory groups - `identitystore:DescribeGroup`

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessGrantsInstance.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessGrantsLocation.html

Examples:

Request syntax with placeholder values


resp = client.create_access_grant({
  account_id: "AccountId",
  access_grants_location_id: "AccessGrantsLocationId", # required
  access_grants_location_configuration: {
    s3_sub_prefix: "S3Prefix",
  },
  grantee: { # required
    grantee_type: "DIRECTORY_USER", # accepts DIRECTORY_USER, DIRECTORY_GROUP, IAM
    grantee_identifier: "GranteeIdentifier",
  },
  permission: "READ", # required, accepts READ, WRITE, READWRITE
  application_arn: "IdentityCenterApplicationArn",
  s3_prefix_type: "Object", # accepts Object
  tags: [
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
})

Response structure


resp.created_at #=> Time
resp.access_grant_id #=> String
resp.access_grant_arn #=> String
resp.grantee.grantee_type #=> String, one of "DIRECTORY_USER", "DIRECTORY_GROUP", "IAM"
resp.grantee.grantee_identifier #=> String
resp.access_grants_location_id #=> String
resp.access_grants_location_configuration.s3_sub_prefix #=> String
resp.permission #=> String, one of "READ", "WRITE", "READWRITE"
resp.application_arn #=> String
resp.grant_scope #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :access_grants_location_id (required, String) —

    The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID ‘default` to the default location `s3://` and assigns an auto-generated ID to other locations that you register.

    If you are passing the ‘default` location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the `Subprefix` field.

  • :access_grants_location_configuration (Types::AccessGrantsLocationConfiguration) —

    The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the ‘S3SubPrefix` field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

  • :grantee (required, Types::Grantee) —

    The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

  • :permission (required, String) —

    The type of access that you are granting to your S3 data, which can be set to one of the following values:

    • ‘READ` – Grant read-only access to the S3 data.

    • ‘WRITE` – Grant write-only access to the S3 data.

    • ‘READWRITE` – Grant both read and write access to the S3 data.

  • :application_arn (String) —

    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.

  • :s3_prefix_type (String) —

    The type of ‘S3SubPrefix`. The only possible value is `Object`. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.

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

    The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

Returns:

See Also:



675
676
677
678
 
# File 'lib/aws-sdk-s3control/client.rb', line 675

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

#create_access_grants_instance(params = {}) ⇒ Types::CreateAccessGrantsInstanceResult

Creates an S3 Access Grants instance, which serves as a logical grouping for access grants. You can create one S3 Access Grants instance per Region per account.

Permissions

: You must have the ‘s3:CreateAccessGrantsInstance` permission to use

this operation.

Additional Permissions

: To associate an IAM Identity Center instance with your S3 Access

Grants instance, you must also have the `sso:DescribeInstance`,
`sso:CreateApplication`, `sso:PutApplicationGrant`, and
`sso:PutApplicationAuthenticationMethod` permissions.

Examples:

Request syntax with placeholder values


resp = client.create_access_grants_instance({
  account_id: "AccountId",
  identity_center_arn: "IdentityCenterArn",
  tags: [
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
})

Response structure


resp.created_at #=> Time
resp.access_grants_instance_id #=> String
resp.access_grants_instance_arn #=> String
resp.identity_center_arn #=> String
resp.identity_center_instance_arn #=> String
resp.identity_center_application_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :identity_center_arn (String) —

    If you would like to associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, use this field to pass the Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the [ListInstances] API operation to retrieve a list of your Identity Center instances and their ARNs.

    [1]: docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListInstances.html

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

    The Amazon Web Services resource tags that you are adding to the S3 Access Grants instance. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

Returns:

See Also:



754
755
756
757
 
# File 'lib/aws-sdk-s3control/client.rb', line 754

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

#create_access_grants_location(params = {}) ⇒ Types::CreateAccessGrantsLocationResult

The S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

  • The default S3 location ‘s3://`

  • A bucket - ‘S3://<bucket-name>`

  • A bucket and prefix - ‘S3://<bucket-name>/<prefix>`

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role [using a policy]. S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

Permissions

: You must have the ‘s3:CreateAccessGrantsLocation` permission to use

this operation.

Additional Permissions

: You must also have the following permission for the specified IAM

role: `iam:PassRole`

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-location.html

Examples:

Request syntax with placeholder values


resp = client.create_access_grants_location({
  account_id: "AccountId",
  location_scope: "S3Prefix", # required
  iam_role_arn: "IAMRoleArn", # required
  tags: [
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
})

Response structure


resp.created_at #=> Time
resp.access_grants_location_id #=> String
resp.access_grants_location_arn #=> String
resp.location_scope #=> String
resp.iam_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :location_scope (required, String) —

    The S3 path to the location that you are registering. The location scope can be the default S3 location ‘s3://`, the S3 path to a bucket `s3://<bucket>`, or the S3 path to a bucket and prefix `s3://<bucket>/<prefix>`. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the `engineering/` prefix or object key names that start with the `marketing/campaigns/` prefix.

  • :iam_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

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

    The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

Returns:

See Also:



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

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

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

Creates an access point and associates it to a specified bucket. For more information, see [Managing access to shared datasets with access points] or [Managing access to shared datasets in directory buckets with access points] in the *Amazon S3 User Guide*.

To create an access point and attach it to a volume on an Amazon FSx file system, see [CreateAndAttachS3AccessPoint] in the *Amazon FSx API Reference*.

<note markdown=“1”> S3 on Outposts only supports VPC-style access points.

For more information, see [ Accessing Amazon S3 on Outposts using

virtual private cloud (VPC) only access points] in the *Amazon S3 User Guide*.

</note>

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘CreateAccessPoint`:

  • GetAccessPoint][6
  • DeleteAccessPoint][7
  • ListAccessPoints][8
  • ListAccessPointsForDirectoryBuckets][9

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html [3]: docs.aws.amazon.com/fsx/latest/APIReference/API_CreateAndAttachS3AccessPoint.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForDirectoryBuckets.html

Examples:

Request syntax with placeholder values


resp = client.create_access_point({
  account_id: "AccountId",
  name: "AccessPointName", # required
  bucket: "BucketName", # required
  vpc_configuration: {
    vpc_id: "VpcId", # required
  },
  public_access_block_configuration: {
    block_public_acls: false,
    ignore_public_acls: false,
    block_public_policy: false,
    restrict_public_buckets: false,
  },
  bucket_account_id: "AccountId",
  scope: {
    prefixes: ["Prefix"],
    permissions: ["GetObject"], # accepts GetObject, GetObjectAttributes, ListMultipartUploadParts, ListBucket, ListBucketMultipartUploads, PutObject, DeleteObject, AbortMultipartUpload
  },
  tags: [
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
})

Response structure


resp.access_point_arn #=> String
resp.alias #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the account that owns the specified access point.

  • :name (required, String) —

    The name you want to assign to this access point.

    For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the ‘ZoneID` (Amazon Web Services Availability Zone or Local Zone) of your bucket location, followed by `–xa-s3`. For more information, see [Managing access to shared datasets in directory buckets with access points] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html

  • :bucket (required, String) —

    The name of the bucket that you want to associate this access point with.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

  • :vpc_configuration (Types::VpcConfiguration) —

    If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

    <note markdown=“1”> This is required for creating an access point for Amazon S3 on Outposts buckets.

    </note>
  • :public_access_block_configuration (Types::PublicAccessBlockConfiguration) —

    The ‘PublicAccessBlock` configuration that you want to apply to the access point.

  • :bucket_account_id (String) —

    The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

    For same account access point when your bucket and access point belong to the same account owner, the ‘BucketAccountId` is not required. For cross-account access point when your bucket and access point are not in the same account, the `BucketAccountId` is required.

  • :scope (Types::Scope) —

    For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. For more information, see [Managing access to shared datasets in directory buckets with access points] in the *Amazon S3 User Guide*.

    <note markdown=“1”> Scope is only supported for access points attached to directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html

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

    An array of tags that you can apply to an access point. Tags are key-value pairs of metadata used to control access to your access points. For more information about tags, see [Using tags with Amazon S3]. For information about tagging access points, see [Using tags for attribute-based access control (ABAC)].

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html#using-tags-for-abac

Returns:

See Also:



1029
1030
1031
1032
 
# File 'lib/aws-sdk-s3control/client.rb', line 1029

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

#create_access_point_for_object_lambda(params = {}) ⇒ Types::CreateAccessPointForObjectLambdaResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Creates an Object Lambda Access Point. For more information, see

Transforming objects with Object Lambda Access Points][1

in the

*Amazon S3 User Guide*.

The following actions are related to ‘CreateAccessPointForObjectLambda`:

  • DeleteAccessPointForObjectLambda][2
  • GetAccessPointForObjectLambda][3
  • ListAccessPointsForObjectLambda][4

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html

Examples:

Request syntax with placeholder values


resp = client.create_access_point_for_object_lambda({
  account_id: "AccountId",
  name: "ObjectLambdaAccessPointName", # required
  configuration: { # required
    supporting_access_point: "ObjectLambdaSupportingAccessPointArn", # required
    cloud_watch_metrics_enabled: false,
    allowed_features: ["GetObject-Range"], # accepts GetObject-Range, GetObject-PartNumber, HeadObject-Range, HeadObject-PartNumber
    transformation_configurations: [ # required
      {
        actions: ["GetObject"], # required, accepts GetObject, HeadObject, ListObjects, ListObjectsV2
        content_transformation: { # required
          aws_lambda: {
            function_arn: "FunctionArnString", # required
            function_payload: "AwsLambdaTransformationPayload",
          },
        },
      },
    ],
  },
})

Response structure


resp.object_lambda_access_point_arn #=> String
resp.alias.value #=> String
resp.alias.status #=> String, one of "PROVISIONING", "READY"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for owner of the specified Object Lambda Access Point.

  • :name (required, String) —

    The name you want to assign to this Object Lambda Access Point.

  • :configuration (required, Types::ObjectLambdaConfiguration) —

    Object Lambda Access Point configuration as a JSON document.

Returns:

See Also:



1106
1107
1108
1109
 
# File 'lib/aws-sdk-s3control/client.rb', line 1106

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

#create_bucket(params = {}) ⇒ Types::CreateBucketResult

<note markdown=“1”> This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see [Create Bucket] in the *Amazon S3 API Reference*.

</note>

Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see [Using Amazon S3 on Outposts] in *Amazon S3 User Guide*.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see [Working with Amazon S3 Buckets].

S3 on Outposts buckets support:

  • Tags

  • LifecycleConfigurations for deleting expired objects

For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see [ Amazon S3 on Outposts Restrictions and Limitations].

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and ‘x-amz-outpost-id` in your API request, see the [Examples] section.

The following actions are related to ‘CreateBucket` for Amazon S3 on Outposts:

  • PutObject][6
  • GetBucket][7
  • DeleteBucket][8
  • CreateAccessPoint][9
  • PutAccessPointPolicy][10

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OnOutpostsRestrictionsLimitations.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html#API_control_CreateBucket_Examples [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html

Examples:

Request syntax with placeholder values


resp = client.create_bucket({
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read
  bucket: "BucketName", # required
  create_bucket_configuration: {
    location_constraint: "EU", # accepts EU, eu-west-1, us-west-1, us-west-2, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1, cn-north-1, eu-central-1
  },
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write: "GrantWrite",
  grant_write_acp: "GrantWriteACP",
  object_lock_enabled_for_bucket: false,
  outpost_id: "NonEmptyMaxLength64String",
})

Response structure


resp.location #=> String
resp.bucket_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :acl (String) —

    The canned ACL to apply to the bucket.

    <note markdown=“1”> This is not supported by Amazon S3 on Outposts buckets.

    </note>
  • :bucket (required, String) —

    The name of the bucket.

  • :create_bucket_configuration (Types::CreateBucketConfiguration) —

    The configuration information for the bucket.

    <note markdown=“1”> This is not supported by Amazon S3 on Outposts buckets.

    </note>
  • :grant_full_control (String) —

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    <note markdown=“1”> This is not supported by Amazon S3 on Outposts buckets.

    </note>
  • :grant_read (String) —

    Allows grantee to list the objects in the bucket.

    <note markdown=“1”> This is not supported by Amazon S3 on Outposts buckets.

    </note>
  • :grant_read_acp (String) —

    Allows grantee to read the bucket ACL.

    <note markdown=“1”> This is not supported by Amazon S3 on Outposts buckets.

    </note>
  • :grant_write (String) —

    Allows grantee to create, overwrite, and delete any object in the bucket.

    <note markdown=“1”> This is not supported by Amazon S3 on Outposts buckets.

    </note>
  • :grant_write_acp (String) —

    Allows grantee to write the ACL for the applicable bucket.

    <note markdown=“1”> This is not supported by Amazon S3 on Outposts buckets.

    </note>
  • :object_lock_enabled_for_bucket (Boolean) —

    Specifies whether you want S3 Object Lock to be enabled for the new bucket.

    <note markdown=“1”> This is not supported by Amazon S3 on Outposts buckets.

    </note>
  • :outpost_id (String) —

    The ID of the Outposts where the bucket is being created.

    <note markdown=“1”> This ID is required by Amazon S3 on Outposts buckets.

    </note>

Returns:

See Also:



1264
1265
1266
1267
 
# File 'lib/aws-sdk-s3control/client.rb', line 1264

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

#create_job(params = {}) ⇒ Types::CreateJobResult

This operation creates an S3 Batch Operations job.

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see

S3 Batch Operations][1

in the *Amazon S3 User Guide*.

Permissions

: For information about permissions required to use the Batch

Operations, see [Granting permissions for S3 Batch Operations][2] in
the *Amazon S3 User Guide*.

Related actions include:

  • DescribeJob][3
  • ListJobs][4
  • UpdateJobPriority][5
  • UpdateJobStatus][6
  • JobOperation][7

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops-iam-role-policies.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.html

Examples:

Request syntax with placeholder values


resp = client.create_job({
  account_id: "AccountId",
  confirmation_required: false,
  operation: { # required
    lambda_invoke: {
      function_arn: "FunctionArnString",
      invocation_schema_version: "NonEmptyMaxLength64String",
      user_arguments: {
        "NonEmptyMaxLength64String" => "MaxLength1024String",
      },
    },
    s3_put_object_copy: {
      target_resource: "S3RegionalOrS3ExpressBucketArnString",
      canned_access_control_list: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control
      access_control_grants: [
        {
          grantee: {
            type_identifier: "id", # accepts id, emailAddress, uri
            identifier: "NonEmptyMaxLength1024String",
            display_name: "NonEmptyMaxLength1024String",
          },
          permission: "FULL_CONTROL", # accepts FULL_CONTROL, READ, WRITE, READ_ACP, WRITE_ACP
        },
      ],
      metadata_directive: "COPY", # accepts COPY, REPLACE
      modified_since_constraint: Time.now,
      new_object_metadata: {
        cache_control: "NonEmptyMaxLength1024String",
        content_disposition: "NonEmptyMaxLength1024String",
        content_encoding: "NonEmptyMaxLength1024String",
        content_language: "NonEmptyMaxLength1024String",
        user_metadata: {
          "NonEmptyMaxLength1024String" => "MaxLength1024String",
        },
        content_length: 1,
        content_md5: "NonEmptyMaxLength1024String",
        content_type: "NonEmptyMaxLength1024String",
        http_expires_date: Time.now,
        requester_charged: false,
        sse_algorithm: "AES256", # accepts AES256, KMS
      },
      new_object_tagging: [
        {
          key: "TagKeyString", # required
          value: "TagValueString", # required
        },
      ],
      redirect_location: "NonEmptyMaxLength2048String",
      requester_pays: false,
      storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR
      un_modified_since_constraint: Time.now,
      sse_aws_kms_key_id: "KmsKeyArnString",
      target_key_prefix: "NonEmptyMaxLength1024String",
      object_lock_legal_hold_status: "OFF", # accepts OFF, ON
      object_lock_mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
      object_lock_retain_until_date: Time.now,
      bucket_key_enabled: false,
      checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256, CRC64NVME
    },
    s3_put_object_acl: {
      access_control_policy: {
        access_control_list: {
          owner: { # required
            id: "NonEmptyMaxLength1024String",
            display_name: "NonEmptyMaxLength1024String",
          },
          grants: [
            {
              grantee: {
                type_identifier: "id", # accepts id, emailAddress, uri
                identifier: "NonEmptyMaxLength1024String",
                display_name: "NonEmptyMaxLength1024String",
              },
              permission: "FULL_CONTROL", # accepts FULL_CONTROL, READ, WRITE, READ_ACP, WRITE_ACP
            },
          ],
        },
        canned_access_control_list: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control
      },
    },
    s3_put_object_tagging: {
      tag_set: [
        {
          key: "TagKeyString", # required
          value: "TagValueString", # required
        },
      ],
    },
    s3_delete_object_tagging: {
    },
    s3_initiate_restore_object: {
      expiration_in_days: 1,
      glacier_job_tier: "BULK", # accepts BULK, STANDARD
    },
    s3_put_object_legal_hold: {
      legal_hold: { # required
        status: "OFF", # required, accepts OFF, ON
      },
    },
    s3_put_object_retention: {
      bypass_governance_retention: false,
      retention: { # required
        retain_until_date: Time.now,
        mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
      },
    },
    s3_replicate_object: {
    },
    s3_compute_object_checksum: {
      checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, CRC64NVME, MD5, SHA1, SHA256
      checksum_type: "FULL_OBJECT", # accepts FULL_OBJECT, COMPOSITE
    },
  },
  report: { # required
    bucket: "S3BucketArnString",
    format: "Report_CSV_20180820", # accepts Report_CSV_20180820
    enabled: false, # required
    prefix: "ReportPrefixString",
    report_scope: "AllTasks", # accepts AllTasks, FailedTasksOnly
    expected_bucket_owner: "AccountId",
  },
  client_request_token: "NonEmptyMaxLength64String", # required
  manifest: {
    spec: { # required
      format: "S3BatchOperations_CSV_20180820", # required, accepts S3BatchOperations_CSV_20180820, S3InventoryReport_CSV_20161130
      fields: ["Ignore"], # accepts Ignore, Bucket, Key, VersionId
    },
    location: { # required
      object_arn: "S3KeyArnString", # required
      object_version_id: "S3ObjectVersionId",
      etag: "NonEmptyMaxLength1024String", # required
    },
  },
  description: "NonEmptyMaxLength256String",
  priority: 1, # required
  role_arn: "IAMRoleArn", # required
  tags: [
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
  manifest_generator: {
    s3_job_manifest_generator: {
      expected_bucket_owner: "AccountId",
      source_bucket: "S3BucketArnString", # required
      manifest_output_location: {
        expected_manifest_bucket_owner: "AccountId",
        bucket: "S3BucketArnString", # required
        manifest_prefix: "ManifestPrefixString",
        manifest_encryption: {
          sses3: {
          },
          ssekms: {
            key_id: "KmsKeyArnString", # required
          },
        },
        manifest_format: "S3InventoryReport_CSV_20211130", # required, accepts S3InventoryReport_CSV_20211130
      },
      filter: {
        eligible_for_replication: false,
        created_after: Time.now,
        created_before: Time.now,
        object_replication_statuses: ["COMPLETED"], # accepts COMPLETED, FAILED, REPLICA, NONE
        key_name_constraint: {
          match_any_prefix: ["NonEmptyMaxLength1024String"],
          match_any_suffix: ["NonEmptyMaxLength1024String"],
          match_any_substring: ["NonEmptyMaxLength1024String"],
        },
        object_size_greater_than_bytes: 1,
        object_size_less_than_bytes: 1,
        match_any_storage_class: ["STANDARD"], # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR
        match_any_object_encryption: [
          {
            sses3: {
            },
            ssekms: {
              kms_key_arn: "NonEmptyKmsKeyArnString",
              bucket_key_enabled: false,
            },
            dssekms: {
              kms_key_arn: "NonEmptyKmsKeyArnString",
            },
            ssec: {
            },
            notsse: {
            },
          },
        ],
      },
      enable_manifest_output: false, # required
    },
  },
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID that creates the job.

  • :confirmation_required (Boolean) —

    Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

  • :operation (required, Types::JobOperation) —

    The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see

    Operations][1

    in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html

  • :report (required, Types::JobReport) —

    Configuration parameters for the optional job-completion report.

  • :client_request_token (required, String) —

    An idempotency token to ensure that you don’t accidentally submit the same request twice. You can use any string up to the maximum length.

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

  • :manifest (Types::JobManifest) —

    Configuration parameters for the manifest.

  • :description (String) —

    A description for this job. You can use any string within the permitted length. Descriptions don’t need to be unique and can be used for multiple jobs.

  • :priority (required, Integer) —

    The numerical priority for this job. Higher numbers indicate higher priority.

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job’s action on every object in the manifest.

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

    A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

  • :manifest_generator (Types::JobManifestGenerator) —

    The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

Returns:

See Also:



1568
1569
1570
1571
 
# File 'lib/aws-sdk-s3control/client.rb', line 1568

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

#create_multi_region_access_point(params = {}) ⇒ Types::CreateMultiRegionAccessPointResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see [Creating Multi-Region Access Points] in the *Amazon S3 User Guide*.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see [Multi-Region Access Point restrictions and limitations] in the *Amazon S3 User Guide*.

This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with ‘DescribeMultiRegionAccessPointOperation`.

The following actions are related to ‘CreateMultiRegionAccessPoint`:

  • DeleteMultiRegionAccessPoint][3
  • DescribeMultiRegionAccessPointOperation][4
  • GetMultiRegionAccessPoint][5
  • ListMultiRegionAccessPoints][6

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html

Examples:

Request syntax with placeholder values


resp = client.create_multi_region_access_point({
  account_id: "AccountId",
  client_token: "MultiRegionAccessPointClientToken", # required
  details: { # required
    name: "MultiRegionAccessPointName", # required
    public_access_block: {
      block_public_acls: false,
      ignore_public_acls: false,
      block_public_policy: false,
      restrict_public_buckets: false,
    },
    regions: [ # required
      {
        bucket: "BucketName", # required
        bucket_account_id: "AccountId",
      },
    ],
  },
})

Response structure


resp.request_token_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point. The owner of the Multi-Region Access Point also must own the underlying buckets.

  • :client_token (required, String) —

    An idempotency token used to identify the request and guarantee that requests are unique.

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

  • :details (required, Types::CreateMultiRegionAccessPointInput) —

    A container element containing details about the Multi-Region Access Point.

Returns:

See Also:



1661
1662
1663
1664
 
# File 'lib/aws-sdk-s3control/client.rb', line 1661

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

#create_storage_lens_group(params = {}) ⇒ Struct

Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An S3 Storage Lens group is a custom grouping of objects based on prefix, suffix, object tags, object size, object age, or a combination of these filters. For each Storage Lens group that you’ve created, you can also optionally add Amazon Web Services resource tags. For more information about S3 Storage Lens groups, see [Working with S3 Storage Lens groups].

To use this operation, you must have the permission to perform the ‘s3:CreateStorageLensGroup` action. If you’re trying to create a Storage Lens group with Amazon Web Services resource tags, you must also have permission to perform the `s3:TagResource` action. For more information about the required Storage Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups].

For information about Storage Lens groups errors, see [List of Amazon S3 Storage Lens error codes].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups-overview.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions [3]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList

Examples:

Request syntax with placeholder values


resp = client.create_storage_lens_group({
  account_id: "AccountId",
  storage_lens_group: { # required
    name: "StorageLensGroupName", # required
    filter: { # required
      match_any_prefix: ["Prefix"],
      match_any_suffix: ["Suffix"],
      match_any_tag: [
        {
          key: "TagKeyString", # required
          value: "TagValueString", # required
        },
      ],
      match_object_age: {
        days_greater_than: 1,
        days_less_than: 1,
      },
      match_object_size: {
        bytes_greater_than: 1,
        bytes_less_than: 1,
      },
      and: {
        match_any_prefix: ["Prefix"],
        match_any_suffix: ["Suffix"],
        match_any_tag: [
          {
            key: "TagKeyString", # required
            value: "TagValueString", # required
          },
        ],
        match_object_age: {
          days_greater_than: 1,
          days_less_than: 1,
        },
        match_object_size: {
          bytes_greater_than: 1,
          bytes_less_than: 1,
        },
      },
      or: {
        match_any_prefix: ["Prefix"],
        match_any_suffix: ["Suffix"],
        match_any_tag: [
          {
            key: "TagKeyString", # required
            value: "TagValueString", # required
          },
        ],
        match_object_age: {
          days_greater_than: 1,
          days_less_than: 1,
        },
        match_object_size: {
          bytes_greater_than: 1,
          bytes_less_than: 1,
        },
      },
    },
    storage_lens_group_arn: "StorageLensGroupArn",
  },
  tags: [
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID that the Storage Lens group is created from and associated with.

  • :storage_lens_group (required, Types::StorageLensGroup) —

    The Storage Lens group configuration.

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

    The Amazon Web Services resource tags that you’re adding to your Storage Lens group. This parameter is optional.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1777
1778
1779
1780
 
# File 'lib/aws-sdk-s3control/client.rb', line 1777

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

#delete_access_grant(params = {}) ⇒ Struct

Deletes the access grant from the S3 Access Grants instance. You cannot undo an access grant deletion and the grantee will no longer have access to the S3 data.

Permissions

: You must have the ‘s3:DeleteAccessGrant` permission to use this

operation.

Examples:

Request syntax with placeholder values


resp = client.delete_access_grant({
  account_id: "AccountId",
  access_grant_id: "AccessGrantId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :access_grant_id (required, String) —

    The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1811
1812
1813
1814
 
# File 'lib/aws-sdk-s3control/client.rb', line 1811

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

#delete_access_grants_instance(params = {}) ⇒ Struct

Deletes your S3 Access Grants instance. You must first delete the access grants and locations before S3 Access Grants can delete the instance. See [DeleteAccessGrant] and [DeleteAccessGrantsLocation]. If you have associated an IAM Identity Center instance with your S3 Access Grants instance, you must first dissassociate the Identity Center instance from the S3 Access Grants instance before you can delete the S3 Access Grants instance. See [AssociateAccessGrantsIdentityCenter] and [DissociateAccessGrantsIdentityCenter].

Permissions

: You must have the ‘s3:DeleteAccessGrantsInstance` permission to use

this operation.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessGrant.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessGrantsLocation.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_AssociateAccessGrantsIdentityCenter.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DissociateAccessGrantsIdentityCenter.html

Examples:

Request syntax with placeholder values


resp = client.delete_access_grants_instance({
  account_id: "AccountId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1853
1854
1855
1856
 
# File 'lib/aws-sdk-s3control/client.rb', line 1853

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

#delete_access_grants_instance_resource_policy(params = {}) ⇒ Struct

Deletes the resource policy of the S3 Access Grants instance. The resource policy is used to manage cross-account access to your S3 Access Grants instance. By deleting the resource policy, you delete any cross-account permissions to your S3 Access Grants instance.

Permissions

: You must have the ‘s3:DeleteAccessGrantsInstanceResourcePolicy`

permission to use this operation.

Examples:

Request syntax with placeholder values


resp = client.delete_access_grants_instance_resource_policy({
  account_id: "AccountId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1883
1884
1885
1886
 
# File 'lib/aws-sdk-s3control/client.rb', line 1883

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

#delete_access_grants_location(params = {}) ⇒ Struct

Deregisters a location from your S3 Access Grants instance. You can only delete a location registration from an S3 Access Grants instance if there are no grants associated with this location. See [Delete a grant] for information on how to delete grants. You need to have at least one registered location in your S3 Access Grants instance in order to create access grants.

Permissions

: You must have the ‘s3:DeleteAccessGrantsLocation` permission to use

this operation.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessGrant.html

Examples:

Request syntax with placeholder values


resp = client.delete_access_grants_location({
  account_id: "AccountId",
  access_grants_location_id: "AccessGrantsLocationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :access_grants_location_id (required, String) —

    The ID of the registered location that you are deregistering from your S3 Access Grants instance. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID ‘default` to the default location `s3://` and assigns an auto-generated ID to other locations that you register.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1927
1928
1929
1930
 
# File 'lib/aws-sdk-s3control/client.rb', line 1927

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

#delete_access_point(params = {}) ⇒ Struct

Deletes the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘DeleteAccessPoint`:

  • CreateAccessPoint][2
  • GetAccessPoint][3
  • ListAccessPoints][4

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html

Examples:

Request syntax with placeholder values


resp = client.delete_access_point({
  account_id: "AccountId",
  name: "AccessPointName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the account that owns the specified access point.

  • :name (required, String) —

    The name of the access point you want to delete.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>`. For example, to access the access point `reports-ap` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap`. The value must be URL encoded.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1990
1991
1992
1993
 
# File 'lib/aws-sdk-s3control/client.rb', line 1990

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

#delete_access_point_for_object_lambda(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Deletes the specified Object Lambda Access Point.

The following actions are related to ‘DeleteAccessPointForObjectLambda`:

  • CreateAccessPointForObjectLambda][1
  • GetAccessPointForObjectLambda][2
  • ListAccessPointsForObjectLambda][3

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html

Examples:

Request syntax with placeholder values


resp = client.delete_access_point_for_object_lambda({
  account_id: "AccountId",
  name: "ObjectLambdaAccessPointName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified Object Lambda Access Point.

  • :name (required, String) —

    The name of the access point you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2036
2037
2038
2039
 
# File 'lib/aws-sdk-s3control/client.rb', line 2036

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

#delete_access_point_policy(params = {}) ⇒ Struct

Deletes the access point policy for the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘DeleteAccessPointPolicy`:

  • PutAccessPointPolicy][2
  • GetAccessPointPolicy][3

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html

Examples:

Request syntax with placeholder values


resp = client.delete_access_point_policy({
  account_id: "AccountId",
  name: "AccessPointName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified access point.

  • :name (required, String) —

    The name of the access point whose policy you want to delete.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>`. For example, to access the access point `reports-ap` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap`. The value must be URL encoded.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2097
2098
2099
2100
 
# File 'lib/aws-sdk-s3control/client.rb', line 2097

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

#delete_access_point_policy_for_object_lambda(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Removes the resource policy for an Object Lambda Access Point.

The following actions are related to ‘DeleteAccessPointPolicyForObjectLambda`:

  • GetAccessPointPolicyForObjectLambda][1
  • PutAccessPointPolicyForObjectLambda][2

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html

Examples:

Request syntax with placeholder values


resp = client.delete_access_point_policy_for_object_lambda({
  account_id: "AccountId",
  name: "ObjectLambdaAccessPointName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified Object Lambda Access Point.

  • :name (required, String) —

    The name of the Object Lambda Access Point you want to delete the policy for.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2141
2142
2143
2144
 
# File 'lib/aws-sdk-s3control/client.rb', line 2141

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

#delete_access_point_scope(params = {}) ⇒ Struct

Deletes an existing access point scope for a directory bucket.

<note markdown=“1”> When you delete the scope of an access point, all prefixes and permissions are deleted.

</note>

To use this operation, you must have the permission to perform the ‘s3express:DeleteAccessPointScope` action.

For information about REST API errors, see [REST error responses].

[1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses

Examples:

Request syntax with placeholder values


resp = client.delete_access_point_scope({
  account_id: "AccountId", # required
  name: "AccessPointName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Web Services account ID that owns the access point with the scope that you want to delete.

  • :name (required, String) —

    The name of the access point with the scope that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2182
2183
2184
2185
 
# File 'lib/aws-sdk-s3control/client.rb', line 2182

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

#delete_bucket(params = {}) ⇒ Struct

<note markdown=“1”> This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see [DeleteBucket] in the *Amazon S3 API Reference*.

</note>

Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see

Using Amazon S3 on Outposts][2

in *Amazon S3 User Guide*.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

**Related Resources**

  • CreateBucket][4
  • GetBucket][5
  • DeleteObject][6

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket({
  account_id: "AccountId",
  bucket: "BucketName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID that owns the Outposts bucket.

  • :bucket (required, String) —

    Specifies the bucket being deleted.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2254
2255
2256
2257
 
# File 'lib/aws-sdk-s3control/client.rb', line 2254

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

#delete_bucket_lifecycle_configuration(params = {}) ⇒ Struct

<note markdown=“1”> This action deletes an Amazon S3 on Outposts bucket’s lifecycle configuration. To delete an S3 bucket’s lifecycle configuration, see

DeleteBucketLifecycle][1

in the *Amazon S3 API Reference*.

</note>

Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see [Using Amazon S3 on Outposts] in *Amazon S3 User Guide*.

To use this operation, you must have permission to perform the ‘s3-outposts:PutLifecycleConfiguration` action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

For more information about object expiration, see [Elements to Describe Lifecycle Actions].

Related actions include:

  • PutBucketLifecycleConfiguration][5
  • GetBucketLifecycleConfiguration][6

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples [4]: docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket_lifecycle_configuration({
  account_id: "AccountId",
  bucket: "BucketName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID of the lifecycle configuration to delete.

  • :bucket (required, String) —

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2336
2337
2338
2339
 
# File 'lib/aws-sdk-s3control/client.rb', line 2336

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

#delete_bucket_policy(params = {}) ⇒ Struct

<note markdown=“1”> This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see [DeleteBucketPolicy] in the *Amazon S3 API Reference*.

</note>

This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the ‘s3-outposts:DeleteBucketPolicy` permissions on the specified Outposts bucket and belong to the bucket owner’s account to use this action. For more information, see [Using Amazon S3 on Outposts] in *Amazon S3 User Guide*.

If you don’t have ‘DeleteBucketPolicy` permissions, Amazon S3 returns a `403 Access Denied` error. If you have the correct permissions, but you’re not using an identity that belongs to the bucket owner’s account, Amazon S3 returns a ‘405 Method Not Allowed` error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see [Using Bucket Policies and User Policies].

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘DeleteBucketPolicy`:

  • GetBucketPolicy][5
  • PutBucketPolicy][6

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketPolicy.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket_policy({
  account_id: "AccountId",
  bucket: "BucketName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID of the Outposts bucket.

  • :bucket (required, String) —

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2424
2425
2426
2427
 
# File 'lib/aws-sdk-s3control/client.rb', line 2424

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

#delete_bucket_replication(params = {}) ⇒ Struct

<note markdown=“1”> This operation deletes an Amazon S3 on Outposts bucket’s replication configuration. To delete an S3 bucket’s replication configuration, see [DeleteBucketReplication] in the *Amazon S3 API Reference*.

</note>

Deletes the replication configuration from the specified S3 on Outposts bucket.

To use this operation, you must have permissions to perform the ‘s3-outposts:PutReplicationConfiguration` action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see [Setting up IAM with S3 on Outposts] and [Managing access to S3 on Outposts buckets] in the *Amazon S3 User Guide*.

<note markdown=“1”> It can take a while to propagate ‘PUT` or `DELETE` requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that’s returned by a ‘GET` request soon after a `PUT` or `DELETE` request might return a more recent result than what’s on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.

</note>

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

For information about S3 replication on Outposts configuration, see

Replicating objects for S3 on Outposts][5

in the *Amazon S3 User

Guide*.

The following operations are related to ‘DeleteBucketReplication`:

  • PutBucketReplication][6
  • GetBucketReplication][7

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html#API_control_DeleteBucketReplication_Examples [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket_replication({
  account_id: "AccountId",
  bucket: "BucketName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket to delete the replication configuration for.

  • :bucket (required, String) —

    Specifies the S3 on Outposts bucket to delete the replication configuration for.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2517
2518
2519
2520
 
# File 'lib/aws-sdk-s3control/client.rb', line 2517

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

#delete_bucket_tagging(params = {}) ⇒ Struct

<note markdown=“1”> This action deletes an Amazon S3 on Outposts bucket’s tags. To delete an S3 bucket tags, see [DeleteBucketTagging] in the *Amazon S3 API Reference*.

</note>

Deletes the tags from the Outposts bucket. For more information, see

Using Amazon S3 on Outposts][2

in *Amazon S3 User Guide*.

To use this action, you must have permission to perform the ‘PutBucketTagging` action. By default, the bucket owner has this permission and can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘DeleteBucketTagging`:

  • GetBucketTagging][4
  • PutBucketTagging][5

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket_tagging({
  account_id: "AccountId",
  bucket: "BucketName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket tag set to be removed.

  • :bucket (required, String) —

    The bucket ARN that has the tag set to be removed.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2590
2591
2592
2593
 
# File 'lib/aws-sdk-s3control/client.rb', line 2590

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

#delete_job_tagging(params = {}) ⇒ Struct

Removes the entire tag set from the specified S3 Batch Operations job.

Permissions

: To use the ‘DeleteJobTagging` operation, you must have permission to

perform the `s3:DeleteJobTagging` action. For more information, see
[Controlling access and labeling jobs using tags][1] in the *Amazon
S3 User Guide*.

Related actions include:

  • CreateJob][2
  • GetJobTagging][3
  • PutJobTagging][4

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html

Examples:

Request syntax with placeholder values


resp = client.delete_job_tagging({
  account_id: "AccountId",
  job_id: "JobId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

  • :job_id (required, String) —

    The ID for the S3 Batch Operations job whose tags you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2639
2640
2641
2642
 
# File 'lib/aws-sdk-s3control/client.rb', line 2639

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

#delete_multi_region_access_point(params = {}) ⇒ Types::DeleteMultiRegionAccessPointResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point, only the Multi-Region Access Point itself.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see [Multi-Region Access Point restrictions and limitations] in the *Amazon S3 User Guide*.

This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with ‘DescribeMultiRegionAccessPointOperation`.

The following actions are related to ‘DeleteMultiRegionAccessPoint`:

  • CreateMultiRegionAccessPoint][2
  • DescribeMultiRegionAccessPointOperation][3
  • GetMultiRegionAccessPoint][4
  • ListMultiRegionAccessPoints][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html

Examples:

Request syntax with placeholder values


resp = client.delete_multi_region_access_point({
  account_id: "AccountId",
  client_token: "MultiRegionAccessPointClientToken", # required
  details: { # required
    name: "MultiRegionAccessPointName", # required
  },
})

Response structure


resp.request_token_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

  • :client_token (required, String) —

    An idempotency token used to identify the request and guarantee that requests are unique.

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

  • :details (required, Types::DeleteMultiRegionAccessPointInput) —

    A container element containing details about the Multi-Region Access Point.

Returns:

See Also:



2717
2718
2719
2720
 
# File 'lib/aws-sdk-s3control/client.rb', line 2717

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

#delete_public_access_block(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Removes the ‘PublicAccessBlock` configuration for an Amazon Web Services account. This operation might be restricted when the account is managed by organization-level Block Public Access policies. You’ll get an Access Denied (403) error when the account is managed by organization-level Block Public Access policies. Organization-level policies override account-level settings, preventing direct account-level modifications. For more information, see [ Using Amazon S3 block public access].

Related actions include:

  • GetPublicAccessBlock][2
  • PutPublicAccessBlock][3

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html

Examples:

Request syntax with placeholder values


resp = client.delete_public_access_block({
  account_id: "AccountId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the Amazon Web Services account whose ‘PublicAccessBlock` configuration you want to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2763
2764
2765
2766
 
# File 'lib/aws-sdk-s3control/client.rb', line 2763

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

#delete_storage_lens_configuration(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see [Assessing your storage activity and usage with Amazon S3 Storage Lens ][1] in the *Amazon S3 User Guide*.

<note markdown=“1”> To use this action, you must have permission to perform the ‘s3:DeleteStorageLensConfiguration` action. For more information, see

Setting permissions to use Amazon S3 Storage Lens][2

in the *Amazon

S3 User Guide*.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html

Examples:

Request syntax with placeholder values


resp = client.delete_storage_lens_configuration({
  config_id: "ConfigId", # required
  account_id: "AccountId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :config_id (required, String) —

    The ID of the S3 Storage Lens configuration.

  • :account_id (String) —

    The account ID of the requester.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2807
2808
2809
2810
 
# File 'lib/aws-sdk-s3control/client.rb', line 2807

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

#delete_storage_lens_configuration_tagging(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see [Assessing your storage activity and usage with Amazon S3 Storage Lens ][1] in the *Amazon S3 User Guide*.

<note markdown=“1”> To use this action, you must have permission to perform the ‘s3:DeleteStorageLensConfigurationTagging` action. For more information, see [Setting permissions to use Amazon S3 Storage Lens] in the *Amazon S3 User Guide*.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html

Examples:

Request syntax with placeholder values


resp = client.delete_storage_lens_configuration_tagging({
  config_id: "ConfigId", # required
  account_id: "AccountId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :config_id (required, String) —

    The ID of the S3 Storage Lens configuration.

  • :account_id (String) —

    The account ID of the requester.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2852
2853
2854
2855
 
# File 'lib/aws-sdk-s3control/client.rb', line 2852

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

#delete_storage_lens_group(params = {}) ⇒ Struct

Deletes an existing S3 Storage Lens group.

To use this operation, you must have the permission to perform the ‘s3:DeleteStorageLensGroup` action. For more information about the required Storage Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups].

For information about Storage Lens groups errors, see [List of Amazon S3 Storage Lens error codes].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions [2]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList

Examples:

Request syntax with placeholder values


resp = client.delete_storage_lens_group({
  name: "StorageLensGroupName", # required
  account_id: "AccountId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Storage Lens group that you’re trying to delete.

  • :account_id (String) —

    The Amazon Web Services account ID used to create the Storage Lens group that you’re trying to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2892
2893
2894
2895
 
# File 'lib/aws-sdk-s3control/client.rb', line 2892

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

#describe_job(params = {}) ⇒ Types::DescribeJobResult

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see [S3 Batch Operations] in the *Amazon S3 User Guide*.

Permissions

: To use the ‘DescribeJob` operation, you must have permission to

perform the `s3:DescribeJob` action.

Related actions include:

  • CreateJob][2
  • ListJobs][3
  • UpdateJobPriority][4
  • UpdateJobStatus][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html

Examples:

Request syntax with placeholder values


resp = client.describe_job({
  account_id: "AccountId",
  job_id: "JobId", # required
})

Response structure


resp.job.job_id #=> String
resp.job.confirmation_required #=> Boolean
resp.job.description #=> String
resp.job.job_arn #=> String
resp.job.status #=> String, one of "Active", "Cancelled", "Cancelling", "Complete", "Completing", "Failed", "Failing", "New", "Paused", "Pausing", "Preparing", "Ready", "Suspended"
resp.job.manifest.spec.format #=> String, one of "S3BatchOperations_CSV_20180820", "S3InventoryReport_CSV_20161130"
resp.job.manifest.spec.fields #=> Array
resp.job.manifest.spec.fields[0] #=> String, one of "Ignore", "Bucket", "Key", "VersionId"
resp.job.manifest.location.object_arn #=> String
resp.job.manifest.location.object_version_id #=> String
resp.job.manifest.location.etag #=> String
resp.job.operation.lambda_invoke.function_arn #=> String
resp.job.operation.lambda_invoke.invocation_schema_version #=> String
resp.job.operation.lambda_invoke.user_arguments #=> Hash
resp.job.operation.lambda_invoke.user_arguments["NonEmptyMaxLength64String"] #=> String
resp.job.operation.s3_put_object_copy.target_resource #=> String
resp.job.operation.s3_put_object_copy.canned_access_control_list #=> String, one of "private", "public-read", "public-read-write", "aws-exec-read", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control"
resp.job.operation.s3_put_object_copy.access_control_grants #=> Array
resp.job.operation.s3_put_object_copy.access_control_grants[0].grantee.type_identifier #=> String, one of "id", "emailAddress", "uri"
resp.job.operation.s3_put_object_copy.access_control_grants[0].grantee.identifier #=> String
resp.job.operation.s3_put_object_copy.access_control_grants[0].grantee.display_name #=> String
resp.job.operation.s3_put_object_copy.access_control_grants[0].permission #=> String, one of "FULL_CONTROL", "READ", "WRITE", "READ_ACP", "WRITE_ACP"
resp.job.operation.s3_put_object_copy.metadata_directive #=> String, one of "COPY", "REPLACE"
resp.job.operation.s3_put_object_copy.modified_since_constraint #=> Time
resp.job.operation.s3_put_object_copy.new_object_metadata.cache_control #=> String
resp.job.operation.s3_put_object_copy.new_object_metadata.content_disposition #=> String
resp.job.operation.s3_put_object_copy.new_object_metadata.content_encoding #=> String
resp.job.operation.s3_put_object_copy.new_object_metadata.content_language #=> String
resp.job.operation.s3_put_object_copy.new_object_metadata.user_metadata #=> Hash
resp.job.operation.s3_put_object_copy.new_object_metadata.user_metadata["NonEmptyMaxLength1024String"] #=> String
resp.job.operation.s3_put_object_copy.new_object_metadata.content_length #=> Integer
resp.job.operation.s3_put_object_copy.new_object_metadata.content_md5 #=> String
resp.job.operation.s3_put_object_copy.new_object_metadata.content_type #=> String
resp.job.operation.s3_put_object_copy.new_object_metadata.http_expires_date #=> Time
resp.job.operation.s3_put_object_copy.new_object_metadata.requester_charged #=> Boolean
resp.job.operation.s3_put_object_copy.new_object_metadata.sse_algorithm #=> String, one of "AES256", "KMS"
resp.job.operation.s3_put_object_copy.new_object_tagging #=> Array
resp.job.operation.s3_put_object_copy.new_object_tagging[0].key #=> String
resp.job.operation.s3_put_object_copy.new_object_tagging[0].value #=> String
resp.job.operation.s3_put_object_copy.redirect_location #=> String
resp.job.operation.s3_put_object_copy.requester_pays #=> Boolean
resp.job.operation.s3_put_object_copy.storage_class #=> String, one of "STANDARD", "STANDARD_IA", "ONEZONE_IA", "GLACIER", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "GLACIER_IR"
resp.job.operation.s3_put_object_copy.un_modified_since_constraint #=> Time
resp.job.operation.s3_put_object_copy.sse_aws_kms_key_id #=> String
resp.job.operation.s3_put_object_copy.target_key_prefix #=> String
resp.job.operation.s3_put_object_copy.object_lock_legal_hold_status #=> String, one of "OFF", "ON"
resp.job.operation.s3_put_object_copy.object_lock_mode #=> String, one of "COMPLIANCE", "GOVERNANCE"
resp.job.operation.s3_put_object_copy.object_lock_retain_until_date #=> Time
resp.job.operation.s3_put_object_copy.bucket_key_enabled #=> Boolean
resp.job.operation.s3_put_object_copy.checksum_algorithm #=> String, one of "CRC32", "CRC32C", "SHA1", "SHA256", "CRC64NVME"
resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.owner.id #=> String
resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.owner.display_name #=> String
resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants #=> Array
resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[0].grantee.type_identifier #=> String, one of "id", "emailAddress", "uri"
resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[0].grantee.identifier #=> String
resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[0].grantee.display_name #=> String
resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[0].permission #=> String, one of "FULL_CONTROL", "READ", "WRITE", "READ_ACP", "WRITE_ACP"
resp.job.operation.s3_put_object_acl.access_control_policy.canned_access_control_list #=> String, one of "private", "public-read", "public-read-write", "aws-exec-read", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control"
resp.job.operation.s3_put_object_tagging.tag_set #=> Array
resp.job.operation.s3_put_object_tagging.tag_set[0].key #=> String
resp.job.operation.s3_put_object_tagging.tag_set[0].value #=> String
resp.job.operation.s3_initiate_restore_object.expiration_in_days #=> Integer
resp.job.operation.s3_initiate_restore_object.glacier_job_tier #=> String, one of "BULK", "STANDARD"
resp.job.operation.s3_put_object_legal_hold.legal_hold.status #=> String, one of "OFF", "ON"
resp.job.operation.s3_put_object_retention.bypass_governance_retention #=> Boolean
resp.job.operation.s3_put_object_retention.retention.retain_until_date #=> Time
resp.job.operation.s3_put_object_retention.retention.mode #=> String, one of "COMPLIANCE", "GOVERNANCE"
resp.job.operation.s3_compute_object_checksum.checksum_algorithm #=> String, one of "CRC32", "CRC32C", "CRC64NVME", "MD5", "SHA1", "SHA256"
resp.job.operation.s3_compute_object_checksum.checksum_type #=> String, one of "FULL_OBJECT", "COMPOSITE"
resp.job.priority #=> Integer
resp.job.progress_summary.total_number_of_tasks #=> Integer
resp.job.progress_summary.number_of_tasks_succeeded #=> Integer
resp.job.progress_summary.number_of_tasks_failed #=> Integer
resp.job.progress_summary.timers.elapsed_time_in_active_seconds #=> Integer
resp.job.status_update_reason #=> String
resp.job.failure_reasons #=> Array
resp.job.failure_reasons[0].failure_code #=> String
resp.job.failure_reasons[0].failure_reason #=> String
resp.job.report.bucket #=> String
resp.job.report.format #=> String, one of "Report_CSV_20180820"
resp.job.report.enabled #=> Boolean
resp.job.report.prefix #=> String
resp.job.report.report_scope #=> String, one of "AllTasks", "FailedTasksOnly"
resp.job.report.expected_bucket_owner #=> String
resp.job.creation_time #=> Time
resp.job.termination_date #=> Time
resp.job.role_arn #=> String
resp.job.suspended_date #=> Time
resp.job.suspended_cause #=> String
resp.job.manifest_generator.s3_job_manifest_generator.expected_bucket_owner #=> String
resp.job.manifest_generator.s3_job_manifest_generator.source_bucket #=> String
resp.job.manifest_generator.s3_job_manifest_generator.manifest_output_location.expected_manifest_bucket_owner #=> String
resp.job.manifest_generator.s3_job_manifest_generator.manifest_output_location.bucket #=> String
resp.job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_prefix #=> String
resp.job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_encryption.ssekms.key_id #=> String
resp.job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_format #=> String, one of "S3InventoryReport_CSV_20211130"
resp.job.manifest_generator.s3_job_manifest_generator.filter.eligible_for_replication #=> Boolean
resp.job.manifest_generator.s3_job_manifest_generator.filter.created_after #=> Time
resp.job.manifest_generator.s3_job_manifest_generator.filter.created_before #=> Time
resp.job.manifest_generator.s3_job_manifest_generator.filter.object_replication_statuses #=> Array
resp.job.manifest_generator.s3_job_manifest_generator.filter.object_replication_statuses[0] #=> String, one of "COMPLETED", "FAILED", "REPLICA", "NONE"
resp.job.manifest_generator.s3_job_manifest_generator.filter.key_name_constraint.match_any_prefix #=> Array
resp.job.manifest_generator.s3_job_manifest_generator.filter.key_name_constraint.match_any_prefix[0] #=> String
resp.job.manifest_generator.s3_job_manifest_generator.filter.key_name_constraint.match_any_suffix #=> Array
resp.job.manifest_generator.s3_job_manifest_generator.filter.key_name_constraint.match_any_suffix[0] #=> String
resp.job.manifest_generator.s3_job_manifest_generator.filter.key_name_constraint.match_any_substring #=> Array
resp.job.manifest_generator.s3_job_manifest_generator.filter.key_name_constraint.match_any_substring[0] #=> String
resp.job.manifest_generator.s3_job_manifest_generator.filter.object_size_greater_than_bytes #=> Integer
resp.job.manifest_generator.s3_job_manifest_generator.filter.object_size_less_than_bytes #=> Integer
resp.job.manifest_generator.s3_job_manifest_generator.filter.match_any_storage_class #=> Array
resp.job.manifest_generator.s3_job_manifest_generator.filter.match_any_storage_class[0] #=> String, one of "STANDARD", "STANDARD_IA", "ONEZONE_IA", "GLACIER", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "GLACIER_IR"
resp.job.manifest_generator.s3_job_manifest_generator.filter.match_any_object_encryption #=> Array
resp.job.manifest_generator.s3_job_manifest_generator.filter.match_any_object_encryption[0].ssekms.kms_key_arn #=> String
resp.job.manifest_generator.s3_job_manifest_generator.filter.match_any_object_encryption[0].ssekms.bucket_key_enabled #=> Boolean
resp.job.manifest_generator.s3_job_manifest_generator.filter.match_any_object_encryption[0].dssekms.kms_key_arn #=> String
resp.job.manifest_generator.s3_job_manifest_generator.enable_manifest_output #=> Boolean
resp.job.generated_manifest_descriptor.format #=> String, one of "S3InventoryReport_CSV_20211130"
resp.job.generated_manifest_descriptor.location.object_arn #=> String
resp.job.generated_manifest_descriptor.location.object_version_id #=> String
resp.job.generated_manifest_descriptor.location.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

  • :job_id (required, String) —

    The ID for the job whose information you want to retrieve.

Returns:

See Also:



3069
3070
3071
3072
 
# File 'lib/aws-sdk-s3control/client.rb', line 3069

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

#describe_multi_region_access_point_operation(params = {}) ⇒ Types::DescribeMultiRegionAccessPointOperationResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see

Using Multi-Region Access Points][1

in the *Amazon S3 User Guide*.

The following actions are related to ‘GetMultiRegionAccessPoint`:

  • CreateMultiRegionAccessPoint][2
  • DeleteMultiRegionAccessPoint][3
  • GetMultiRegionAccessPoint][4
  • ListMultiRegionAccessPoints][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/MrapOperations.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html

Examples:

Request syntax with placeholder values


resp = client.describe_multi_region_access_point_operation({
  account_id: "AccountId",
  request_token_arn: "AsyncRequestTokenARN", # required
})

Response structure


resp.async_operation.creation_time #=> Time
resp.async_operation.operation #=> String, one of "CreateMultiRegionAccessPoint", "DeleteMultiRegionAccessPoint", "PutMultiRegionAccessPointPolicy"
resp.async_operation.request_token_arn #=> String
resp.async_operation.request_parameters.create_multi_region_access_point_request.name #=> String
resp.async_operation.request_parameters.create_multi_region_access_point_request.public_access_block.block_public_acls #=> Boolean
resp.async_operation.request_parameters.create_multi_region_access_point_request.public_access_block.ignore_public_acls #=> Boolean
resp.async_operation.request_parameters.create_multi_region_access_point_request.public_access_block.block_public_policy #=> Boolean
resp.async_operation.request_parameters.create_multi_region_access_point_request.public_access_block.restrict_public_buckets #=> Boolean
resp.async_operation.request_parameters.create_multi_region_access_point_request.regions #=> Array
resp.async_operation.request_parameters.create_multi_region_access_point_request.regions[0].bucket #=> String
resp.async_operation.request_parameters.create_multi_region_access_point_request.regions[0]. #=> String
resp.async_operation.request_parameters.delete_multi_region_access_point_request.name #=> String
resp.async_operation.request_parameters.put_multi_region_access_point_policy_request.name #=> String
resp.async_operation.request_parameters.put_multi_region_access_point_policy_request.policy #=> String
resp.async_operation.request_status #=> String
resp.async_operation.response_details.multi_region_access_point_details.regions #=> Array
resp.async_operation.response_details.multi_region_access_point_details.regions[0].name #=> String
resp.async_operation.response_details.multi_region_access_point_details.regions[0].request_status #=> String
resp.async_operation.response_details.error_details.code #=> String
resp.async_operation.response_details.error_details.message #=> String
resp.async_operation.response_details.error_details.resource #=> String
resp.async_operation.response_details.error_details.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

  • :request_token_arn (required, String) —

    The request token associated with the request you want to know about. This request token is returned as part of the response when you make an asynchronous request. You provide this token to query about the status of the asynchronous action.

Returns:

See Also:



3151
3152
3153
3154
 
# File 'lib/aws-sdk-s3control/client.rb', line 3151

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

#dissociate_access_grants_identity_center(params = {}) ⇒ Struct

Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.

Permissions

: You must have the ‘s3:DissociateAccessGrantsIdentityCenter`

permission to use this operation.

Additional Permissions

: You must have the ‘sso:DeleteApplication` permission to use this

operation.

Examples:

Request syntax with placeholder values


resp = client.dissociate_access_grants_identity_center({
  account_id: "AccountId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3184
3185
3186
3187
 
# File 'lib/aws-sdk-s3control/client.rb', line 3184

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

#get_access_grant(params = {}) ⇒ Types::GetAccessGrantResult

Get the details of an access grant from your S3 Access Grants instance.

Permissions

: You must have the ‘s3:GetAccessGrant` permission to use this

operation.

Examples:

Request syntax with placeholder values


resp = client.get_access_grant({
  account_id: "AccountId",
  access_grant_id: "AccessGrantId", # required
})

Response structure


resp.created_at #=> Time
resp.access_grant_id #=> String
resp.access_grant_arn #=> String
resp.grantee.grantee_type #=> String, one of "DIRECTORY_USER", "DIRECTORY_GROUP", "IAM"
resp.grantee.grantee_identifier #=> String
resp.permission #=> String, one of "READ", "WRITE", "READWRITE"
resp.access_grants_location_id #=> String
resp.access_grants_location_configuration.s3_sub_prefix #=> String
resp.grant_scope #=> String
resp.application_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :access_grant_id (required, String) —

    The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

Returns:

See Also:



3240
3241
3242
3243
 
# File 'lib/aws-sdk-s3control/client.rb', line 3240

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

#get_access_grants_instance(params = {}) ⇒ Types::GetAccessGrantsInstanceResult

Retrieves the S3 Access Grants instance for a Region in your account.

Permissions

: You must have the ‘s3:GetAccessGrantsInstance` permission to use

this operation.

<note markdown=“1”> ‘GetAccessGrantsInstance` is not supported for cross-account access. You can only call the API from the account that owns the S3 Access Grants instance.

</note>

Examples:

Request syntax with placeholder values


resp = client.get_access_grants_instance({
  account_id: "AccountId",
})

Response structure


resp.access_grants_instance_arn #=> String
resp.access_grants_instance_id #=> String
resp.identity_center_arn #=> String
resp.identity_center_instance_arn #=> String
resp.identity_center_application_arn #=> String
resp.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

Returns:

See Also:



3289
3290
3291
3292
 
# File 'lib/aws-sdk-s3control/client.rb', line 3289

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

#get_access_grants_instance_for_prefix(params = {}) ⇒ Types::GetAccessGrantsInstanceForPrefixResult

Retrieve the S3 Access Grants instance that contains a particular prefix.

Permissions

: You must have the ‘s3:GetAccessGrantsInstanceForPrefix` permission

for the caller  to use this operation.

Additional Permissions

: The prefix owner account must grant you the following permissions to

their S3 Access Grants instance:
`s3:GetAccessGrantsInstanceForPrefix`.

Examples:

Request syntax with placeholder values


resp = client.get_access_grants_instance_for_prefix({
  account_id: "AccountId",
  s3_prefix: "S3Prefix", # required
})

Response structure


resp.access_grants_instance_arn #=> String
resp.access_grants_instance_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The ID of the Amazon Web Services account that is making this request.

  • :s3_prefix (required, String) —

    The S3 prefix of the access grants that you would like to retrieve.

Returns:

See Also:



3335
3336
3337
3338
 
# File 'lib/aws-sdk-s3control/client.rb', line 3335

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

#get_access_grants_instance_resource_policy(params = {}) ⇒ Types::GetAccessGrantsInstanceResourcePolicyResult

Returns the resource policy of the S3 Access Grants instance.

Permissions

: You must have the ‘s3:GetAccessGrantsInstanceResourcePolicy`

permission to use this operation.

Examples:

Request syntax with placeholder values


resp = client.get_access_grants_instance_resource_policy({
  account_id: "AccountId",
})

Response structure


resp.policy #=> String
resp.organization #=> String
resp.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

Returns:

See Also:



3372
3373
3374
3375
 
# File 'lib/aws-sdk-s3control/client.rb', line 3372

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

#get_access_grants_location(params = {}) ⇒ Types::GetAccessGrantsLocationResult

Retrieves the details of a particular location registered in your S3 Access Grants instance.

Permissions

: You must have the ‘s3:GetAccessGrantsLocation` permission to use

this operation.

Examples:

Request syntax with placeholder values


resp = client.get_access_grants_location({
  account_id: "AccountId",
  access_grants_location_id: "AccessGrantsLocationId", # required
})

Response structure


resp.created_at #=> Time
resp.access_grants_location_id #=> String
resp.access_grants_location_arn #=> String
resp.location_scope #=> String
resp.iam_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :access_grants_location_id (required, String) —

    The ID of the registered location that you are retrieving. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID ‘default` to the default location `s3://` and assigns an auto-generated ID to other locations that you register.

Returns:

See Also:



3421
3422
3423
3424
 
# File 'lib/aws-sdk-s3control/client.rb', line 3421

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

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

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘GetAccessPoint`:

  • CreateAccessPoint][2
  • DeleteAccessPoint][3
  • ListAccessPoints][4

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html

Examples:

Request syntax with placeholder values


resp = client.get_access_point({
  account_id: "AccountId",
  name: "AccessPointName", # required
})

Response structure


resp.name #=> String
resp.bucket #=> String
resp.network_origin #=> String, one of "Internet", "VPC"
resp.vpc_configuration.vpc_id #=> String
resp.public_access_block_configuration.block_public_acls #=> Boolean
resp.public_access_block_configuration.ignore_public_acls #=> Boolean
resp.public_access_block_configuration.block_public_policy #=> Boolean
resp.public_access_block_configuration.restrict_public_buckets #=> Boolean
resp.creation_date #=> Time
resp.alias #=> String
resp.access_point_arn #=> String
resp.endpoints #=> Hash
resp.endpoints["NonEmptyMaxLength64String"] #=> String
resp. #=> String
resp.data_source_id #=> String
resp.data_source_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the account that owns the specified access point.

  • :name (required, String) —

    The name of the access point whose configuration information you want to retrieve.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>`. For example, to access the access point `reports-ap` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap`. The value must be URL encoded.

Returns:

See Also:



3519
3520
3521
3522
 
# File 'lib/aws-sdk-s3control/client.rb', line 3519

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

#get_access_point_configuration_for_object_lambda(params = {}) ⇒ Types::GetAccessPointConfigurationForObjectLambdaResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Returns configuration for an Object Lambda Access Point.

The following actions are related to ‘GetAccessPointConfigurationForObjectLambda`:

  • PutAccessPointConfigurationForObjectLambda][1

^

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointConfigurationForObjectLambda.html

Examples:

Request syntax with placeholder values


resp = client.get_access_point_configuration_for_object_lambda({
  account_id: "AccountId",
  name: "ObjectLambdaAccessPointName", # required
})

Response structure


resp.configuration.supporting_access_point #=> String
resp.configuration.cloud_watch_metrics_enabled #=> Boolean
resp.configuration.allowed_features #=> Array
resp.configuration.allowed_features[0] #=> String, one of "GetObject-Range", "GetObject-PartNumber", "HeadObject-Range", "HeadObject-PartNumber"
resp.configuration.transformation_configurations #=> Array
resp.configuration.transformation_configurations[0].actions #=> Array
resp.configuration.transformation_configurations[0].actions[0] #=> String, one of "GetObject", "HeadObject", "ListObjects", "ListObjectsV2"
resp.configuration.transformation_configurations[0].content_transformation.aws_lambda.function_arn #=> String
resp.configuration.transformation_configurations[0].content_transformation.aws_lambda.function_payload #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified Object Lambda Access Point.

  • :name (required, String) —

    The name of the Object Lambda Access Point you want to return the configuration for.

Returns:

See Also:



3576
3577
3578
3579
 
# File 'lib/aws-sdk-s3control/client.rb', line 3576

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

#get_access_point_for_object_lambda(params = {}) ⇒ Types::GetAccessPointForObjectLambdaResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Returns configuration information about the specified Object Lambda Access Point

The following actions are related to ‘GetAccessPointForObjectLambda`:

  • CreateAccessPointForObjectLambda][1
  • DeleteAccessPointForObjectLambda][2
  • ListAccessPointsForObjectLambda][3

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html

Examples:

Request syntax with placeholder values


resp = client.get_access_point_for_object_lambda({
  account_id: "AccountId",
  name: "ObjectLambdaAccessPointName", # required
})

Response structure


resp.name #=> String
resp.public_access_block_configuration.block_public_acls #=> Boolean
resp.public_access_block_configuration.ignore_public_acls #=> Boolean
resp.public_access_block_configuration.block_public_policy #=> Boolean
resp.public_access_block_configuration.restrict_public_buckets #=> Boolean
resp.creation_date #=> Time
resp.alias.value #=> String
resp.alias.status #=> String, one of "PROVISIONING", "READY"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified Object Lambda Access Point.

  • :name (required, String) —

    The name of the Object Lambda Access Point.

Returns:

See Also:



3638
3639
3640
3641
 
# File 'lib/aws-sdk-s3control/client.rb', line 3638

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

#get_access_point_policy(params = {}) ⇒ Types::GetAccessPointPolicyResult

Returns the access point policy associated with the specified access point.

The following actions are related to ‘GetAccessPointPolicy`:

  • PutAccessPointPolicy][1
  • DeleteAccessPointPolicy][2

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html

Examples:

Request syntax with placeholder values


resp = client.get_access_point_policy({
  account_id: "AccountId",
  name: "AccessPointName", # required
})

Response structure


resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified access point.

  • :name (required, String) —

    The name of the access point whose policy you want to retrieve.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>`. For example, to access the access point `reports-ap` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap`. The value must be URL encoded.

Returns:

See Also:



3695
3696
3697
3698
 
# File 'lib/aws-sdk-s3control/client.rb', line 3695

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

#get_access_point_policy_for_object_lambda(params = {}) ⇒ Types::GetAccessPointPolicyForObjectLambdaResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Returns the resource policy for an Object Lambda Access Point.

The following actions are related to ‘GetAccessPointPolicyForObjectLambda`:

  • DeleteAccessPointPolicyForObjectLambda][1
  • PutAccessPointPolicyForObjectLambda][2

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html

Examples:

Request syntax with placeholder values


resp = client.get_access_point_policy_for_object_lambda({
  account_id: "AccountId",
  name: "ObjectLambdaAccessPointName", # required
})

Response structure


resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified Object Lambda Access Point.

  • :name (required, String) —

    The name of the Object Lambda Access Point.

Returns:

See Also:



3744
3745
3746
3747
 
# File 'lib/aws-sdk-s3control/client.rb', line 3744

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

#get_access_point_policy_status(params = {}) ⇒ Types::GetAccessPointPolicyStatusResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see [Managing Data Access with Amazon S3 access points] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html

Examples:

Request syntax with placeholder values


resp = client.get_access_point_policy_status({
  account_id: "AccountId",
  name: "AccessPointName", # required
})

Response structure


resp.policy_status.is_public #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified access point.

  • :name (required, String) —

    The name of the access point whose policy status you want to retrieve.

Returns:

See Also:



3787
3788
3789
3790
 
# File 'lib/aws-sdk-s3control/client.rb', line 3787

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

#get_access_point_policy_status_for_object_lambda(params = {}) ⇒ Types::GetAccessPointPolicyStatusForObjectLambdaResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Returns the status of the resource policy associated with an Object Lambda Access Point.

Examples:

Request syntax with placeholder values


resp = client.get_access_point_policy_status_for_object_lambda({
  account_id: "AccountId",
  name: "ObjectLambdaAccessPointName", # required
})

Response structure


resp.policy_status.is_public #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified Object Lambda Access Point.

  • :name (required, String) —

    The name of the Object Lambda Access Point.

Returns:

See Also:



3825
3826
3827
3828
 
# File 'lib/aws-sdk-s3control/client.rb', line 3825

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

#get_access_point_scope(params = {}) ⇒ Types::GetAccessPointScopeResult

Returns the access point scope for a directory bucket.

To use this operation, you must have the permission to perform the ‘s3express:GetAccessPointScope` action.

For information about REST API errors, see [REST error responses].

[1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses

Examples:

Request syntax with placeholder values


resp = client.get_access_point_scope({
  account_id: "AccountId", # required
  name: "AccessPointName", # required
})

Response structure


resp.scope.prefixes #=> Array
resp.scope.prefixes[0] #=> String
resp.scope.permissions #=> Array
resp.scope.permissions[0] #=> String, one of "GetObject", "GetObjectAttributes", "ListMultipartUploadParts", "ListBucket", "ListBucketMultipartUploads", "PutObject", "DeleteObject", "AbortMultipartUpload"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Web Services account ID that owns the access point with the scope that you want to retrieve.

  • :name (required, String) —

    The name of the access point with the scope you want to retrieve.

Returns:

See Also:



3870
3871
3872
3873
 
# File 'lib/aws-sdk-s3control/client.rb', line 3870

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

#get_bucket(params = {}) ⇒ Types::GetBucketResult

Gets an Amazon S3 on Outposts bucket. For more information, see [ Using Amazon S3 on Outposts] in the *Amazon S3 User Guide*.

If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the ‘s3-outposts:GetBucket` permissions on the specified Outposts bucket and belong to the Outposts bucket owner’s account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.

If you don’t have ‘s3-outposts:GetBucket` permissions or you’re not using an identity that belongs to the bucket owner’s account, Amazon S3 returns a ‘403 Access Denied` error.

The following actions are related to ‘GetBucket` for Amazon S3 on Outposts:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

  • PutObject][3
  • CreateBucket][4
  • DeleteBucket][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket({
  account_id: "AccountId",
  bucket: "BucketName", # required
})

Response structure


resp.bucket #=> String
resp.public_access_block_enabled #=> Boolean
resp.creation_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket.

  • :bucket (required, String) —

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

Returns:

See Also:



3957
3958
3959
3960
 
# File 'lib/aws-sdk-s3control/client.rb', line 3957

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

#get_bucket_lifecycle_configuration(params = {}) ⇒ Types::GetBucketLifecycleConfigurationResult

<note markdown=“1”> This action gets an Amazon S3 on Outposts bucket’s lifecycle configuration. To get an S3 bucket’s lifecycle configuration, see

GetBucketLifecycleConfiguration][1

in the *Amazon S3 API Reference*.

</note>

Returns the lifecycle configuration information set on the Outposts bucket. For more information, see [Using Amazon S3 on Outposts] and for information about lifecycle configuration, see [ Object Lifecycle Management] in *Amazon S3 User Guide*.

To use this action, you must have permission to perform the ‘s3-outposts:GetLifecycleConfiguration` action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see

Permissions Related to Bucket Subresource Operations][4

and

[Managing Access Permissions to Your Amazon S3 Resources].

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

‘GetBucketLifecycleConfiguration` has the following special error:

  • Error code: ‘NoSuchLifecycleConfiguration`

    • Description: The lifecycle configuration does not exist.

    • HTTP Status Code: 404 Not Found

    • SOAP Fault Code Prefix: Client

The following actions are related to ‘GetBucketLifecycleConfiguration`:

  • PutBucketLifecycleConfiguration][7
  • DeleteBucketLifecycleConfiguration][8

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_lifecycle_configuration({
  account_id: "AccountId",
  bucket: "BucketName", # required
})

Response structure


resp.rules #=> Array
resp.rules[0].expiration.date #=> Time
resp.rules[0].expiration.days #=> Integer
resp.rules[0].expiration.expired_object_delete_marker #=> Boolean
resp.rules[0].id #=> String
resp.rules[0].filter.prefix #=> String
resp.rules[0].filter.tag.key #=> String
resp.rules[0].filter.tag.value #=> String
resp.rules[0].filter.and.prefix #=> String
resp.rules[0].filter.and.tags #=> Array
resp.rules[0].filter.and.tags[0].key #=> String
resp.rules[0].filter.and.tags[0].value #=> String
resp.rules[0].filter.and.object_size_greater_than #=> Integer
resp.rules[0].filter.and.object_size_less_than #=> Integer
resp.rules[0].filter.object_size_greater_than #=> Integer
resp.rules[0].filter.object_size_less_than #=> Integer
resp.rules[0].status #=> String, one of "Enabled", "Disabled"
resp.rules[0].transitions #=> Array
resp.rules[0].transitions[0].date #=> Time
resp.rules[0].transitions[0].days #=> Integer
resp.rules[0].transitions[0].storage_class #=> String, one of "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE"
resp.rules[0].noncurrent_version_transitions #=> Array
resp.rules[0].noncurrent_version_transitions[0].noncurrent_days #=> Integer
resp.rules[0].noncurrent_version_transitions[0].storage_class #=> String, one of "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE"
resp.rules[0].noncurrent_version_expiration.noncurrent_days #=> Integer
resp.rules[0].noncurrent_version_expiration.newer_noncurrent_versions #=> Integer
resp.rules[0].abort_incomplete_multipart_upload.days_after_initiation #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket.

  • :bucket (required, String) —

    The Amazon Resource Name (ARN) of the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

Returns:

See Also:



4080
4081
4082
4083
 
# File 'lib/aws-sdk-s3control/client.rb', line 4080

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

#get_bucket_policy(params = {}) ⇒ Types::GetBucketPolicyResult

<note markdown=“1”> This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see [GetBucketPolicy] in the *Amazon S3 API Reference*.

</note>

Returns the policy of a specified Outposts bucket. For more information, see [Using Amazon S3 on Outposts] in the *Amazon S3 User Guide*.

If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the ‘GetBucketPolicy` permissions on the specified bucket and belong to the bucket owner’s account in order to use this action.

Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don’t have ‘s3-outposts:GetBucketPolicy` permissions or you’re not using an identity that belongs to the bucket owner’s account, Amazon S3 returns a ‘403 Access Denied` error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see [Using Bucket Policies and User Policies].

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘GetBucketPolicy`:

  • GetObject][5
  • PutBucketPolicy][6
  • DeleteBucketPolicy][7

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicy.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_policy({
  account_id: "AccountId",
  bucket: "BucketName", # required
})

Response structure


resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket.

  • :bucket (required, String) —

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

Returns:

See Also:



4178
4179
4180
4181
 
# File 'lib/aws-sdk-s3control/client.rb', line 4178

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

#get_bucket_replication(params = {}) ⇒ Types::GetBucketReplicationResult

<note markdown=“1”> This operation gets an Amazon S3 on Outposts bucket’s replication configuration. To get an S3 bucket’s replication configuration, see

GetBucketReplication][1

in the *Amazon S3 API Reference*.

</note>

Returns the replication configuration of an S3 on Outposts bucket. For more information about S3 on Outposts, see [Using Amazon S3 on Outposts] in the *Amazon S3 User Guide*. For information about S3 replication on Outposts configuration, see [Replicating objects for S3 on Outposts] in the *Amazon S3 User Guide*.

<note markdown=“1”> It can take a while to propagate ‘PUT` or `DELETE` requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that’s returned by a ‘GET` request soon after a `PUT` or `DELETE` request might return a more recent result than what’s on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.

</note>

This action requires permissions for the ‘s3-outposts:GetReplicationConfiguration` action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see [Setting up IAM with S3 on Outposts] and [Managing access to S3 on Outposts bucket] in the *Amazon S3 User Guide*.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

If you include the ‘Filter` element in a replication configuration, you must also include the `DeleteMarkerReplication`, `Status`, and `Priority` elements. The response also returns those elements.

For information about S3 on Outposts replication failure reasons, see

Replication failure reasons][7

in the *Amazon S3 User Guide*.

The following operations are related to ‘GetBucketReplication`:

  • PutBucketReplication][8
  • DeleteBucketReplication][9

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html#API_control_GetBucketReplication_Examples [7]: docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-eventbridge.html#outposts-replication-failure-codes [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_replication({
  account_id: "AccountId",
  bucket: "BucketName", # required
})

Response structure


resp.replication_configuration.role #=> String
resp.replication_configuration.rules #=> Array
resp.replication_configuration.rules[0].id #=> String
resp.replication_configuration.rules[0].priority #=> Integer
resp.replication_configuration.rules[0].prefix #=> String
resp.replication_configuration.rules[0].filter.prefix #=> String
resp.replication_configuration.rules[0].filter.tag.key #=> String
resp.replication_configuration.rules[0].filter.tag.value #=> String
resp.replication_configuration.rules[0].filter.and.prefix #=> String
resp.replication_configuration.rules[0].filter.and.tags #=> Array
resp.replication_configuration.rules[0].filter.and.tags[0].key #=> String
resp.replication_configuration.rules[0].filter.and.tags[0].value #=> String
resp.replication_configuration.rules[0].status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].source_selection_criteria.sse_kms_encrypted_objects.status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].source_selection_criteria.replica_modifications.status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].existing_object_replication.status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].destination. #=> String
resp.replication_configuration.rules[0].destination.bucket #=> String
resp.replication_configuration.rules[0].destination.replication_time.status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].destination.replication_time.time.minutes #=> Integer
resp.replication_configuration.rules[0].destination.access_control_translation.owner #=> String, one of "Destination"
resp.replication_configuration.rules[0].destination.encryption_configuration.replica_kms_key_id #=> String
resp.replication_configuration.rules[0].destination.metrics.status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].destination.metrics.event_threshold.minutes #=> Integer
resp.replication_configuration.rules[0].destination.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR"
resp.replication_configuration.rules[0].delete_marker_replication.status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].bucket #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket.

  • :bucket (required, String) —

    Specifies the bucket to get the replication information for.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

Returns:

See Also:



4309
4310
4311
4312
 
# File 'lib/aws-sdk-s3control/client.rb', line 4309

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

#get_bucket_tagging(params = {}) ⇒ Types::GetBucketTaggingResult

<note markdown=“1”> This action gets an Amazon S3 on Outposts bucket’s tags. To get an S3 bucket tags, see [GetBucketTagging] in the *Amazon S3 API Reference*.

</note>

Returns the tag set associated with the Outposts bucket. For more information, see [Using Amazon S3 on Outposts] in the *Amazon S3 User Guide*.

To use this action, you must have permission to perform the ‘GetBucketTagging` action. By default, the bucket owner has this permission and can grant this permission to others.

‘GetBucketTagging` has the following special error:

  • Error code: ‘NoSuchTagSetError`

    • Description: There is no tag set associated with the bucket.

    ^

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘GetBucketTagging`:

  • PutBucketTagging][4
  • DeleteBucketTagging][5

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_tagging({
  account_id: "AccountId",
  bucket: "BucketName", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket.

  • :bucket (required, String) —

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

Returns:

See Also:



4398
4399
4400
4401
 
# File 'lib/aws-sdk-s3control/client.rb', line 4398

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

#get_bucket_versioning(params = {}) ⇒ Types::GetBucketVersioningResult

<note markdown=“1”> This operation returns the versioning state for S3 on Outposts buckets only. To return the versioning state for an S3 bucket, see

GetBucketVersioning][1

in the *Amazon S3 API Reference*.

</note>

Returns the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.

If you’ve never set versioning on your bucket, it has no versioning state. In that case, the ‘GetBucketVersioning` request does not return a versioning state value.

For more information about versioning, see [Versioning] in the *Amazon S3 User Guide*.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following operations are related to ‘GetBucketVersioning` for S3 on Outposts.

  • PutBucketVersioning][4
  • PutBucketLifecycleConfiguration][5
  • GetBucketLifecycleConfiguration][6

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html#API_control_GetBucketVersioning_Examples [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_versioning({
  account_id: "AccountId",
  bucket: "BucketName", # required
})

Response structure


resp.status #=> String, one of "Enabled", "Suspended"
resp.mfa_delete #=> String, one of "Enabled", "Disabled"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 on Outposts bucket.

  • :bucket (required, String) —

    The S3 on Outposts bucket to return the versioning state for.

Returns:

See Also:



4473
4474
4475
4476
 
# File 'lib/aws-sdk-s3control/client.rb', line 4473

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

#get_data_access(params = {}) ⇒ Types::GetDataAccessResult

Returns a temporary access credential from S3 Access Grants to the grantee or client application. The [temporary credential] is an Amazon Web Services STS token that grants them access to the S3 data.

Permissions

: You must have the ‘s3:GetDataAccess` permission to use this

operation.

Additional Permissions

: The IAM role that S3 Access Grants assumes must have the following

permissions specified in the trust policy when registering the
location: `sts:AssumeRole`, for directory users or groups
`sts:SetContext`, and for IAM users or roles
`sts:SetSourceIdentity`.

[1]: docs.aws.amazon.com/STS/latest/APIReference/API_Credentials.html

Examples:

Request syntax with placeholder values


resp = client.get_data_access({
  account_id: "AccountId",
  target: "S3Prefix", # required
  permission: "READ", # required, accepts READ, WRITE, READWRITE
  duration_seconds: 1,
  privilege: "Minimal", # accepts Minimal, Default
  target_type: "Object", # accepts Object
})

Response structure


resp.credentials.access_key_id #=> String
resp.credentials.secret_access_key #=> String
resp.credentials.session_token #=> String
resp.credentials.expiration #=> Time
resp.matched_grant_target #=> String
resp.grantee.grantee_type #=> String, one of "DIRECTORY_USER", "DIRECTORY_GROUP", "IAM"
resp.grantee.grantee_identifier #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :target (required, String) —

    The S3 URI path of the data to which you are requesting temporary access credentials. If the requesting account has an access grant for this data, S3 Access Grants vends temporary access credentials in the response.

  • :permission (required, String) —

    The type of permission granted to your S3 data, which can be set to one of the following values:

    • ‘READ` – Grant read-only access to the S3 data.

    • ‘WRITE` – Grant write-only access to the S3 data.

    • ‘READWRITE` – Grant both read and write access to the S3 data.

  • :duration_seconds (Integer) —

    The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application. The default value is 1 hour, but the grantee can specify a range from 900 seconds (15 minutes) up to 43200 seconds (12 hours). If the grantee requests a value higher than this maximum, the operation fails.

  • :privilege (String) —

    The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.

    • ‘Default` – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.

    • ‘Minimal` – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.

  • :target_type (String) —

    The type of ‘Target`. The only possible value is `Object`. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix.

Returns:

See Also:



4573
4574
4575
4576
 
# File 'lib/aws-sdk-s3control/client.rb', line 4573

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

#get_job_tagging(params = {}) ⇒ Types::GetJobTaggingResult

Returns the tags on an S3 Batch Operations job.

Permissions

: To use the ‘GetJobTagging` operation, you must have permission to

perform the `s3:GetJobTagging` action. For more information, see
[Controlling access and labeling jobs using tags][1] in the *Amazon
S3 User Guide*.

Related actions include:

  • CreateJob][2
  • PutJobTagging][3
  • DeleteJobTagging][4

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html

Examples:

Request syntax with placeholder values


resp = client.get_job_tagging({
  account_id: "AccountId",
  job_id: "JobId", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

  • :job_id (required, String) —

    The ID for the S3 Batch Operations job whose tags you want to retrieve.

Returns:

See Also:



4631
4632
4633
4634
 
# File 'lib/aws-sdk-s3control/client.rb', line 4631

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

#get_multi_region_access_point(params = {}) ⇒ Types::GetMultiRegionAccessPointResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Returns configuration information about the specified Multi-Region Access Point.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see [Multi-Region Access Point restrictions and limitations] in the *Amazon S3 User Guide*.

The following actions are related to ‘GetMultiRegionAccessPoint`:

  • CreateMultiRegionAccessPoint][2
  • DeleteMultiRegionAccessPoint][3
  • DescribeMultiRegionAccessPointOperation][4
  • ListMultiRegionAccessPoints][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html

Examples:

Request syntax with placeholder values


resp = client.get_multi_region_access_point({
  account_id: "AccountId",
  name: "MultiRegionAccessPointName", # required
})

Response structure


resp.access_point.name #=> String
resp.access_point.alias #=> String
resp.access_point.created_at #=> Time
resp.access_point.public_access_block.block_public_acls #=> Boolean
resp.access_point.public_access_block.ignore_public_acls #=> Boolean
resp.access_point.public_access_block.block_public_policy #=> Boolean
resp.access_point.public_access_block.restrict_public_buckets #=> Boolean
resp.access_point.status #=> String, one of "READY", "INCONSISTENT_ACROSS_REGIONS", "CREATING", "PARTIALLY_CREATED", "PARTIALLY_DELETED", "DELETING"
resp.access_point.regions #=> Array
resp.access_point.regions[0].bucket #=> String
resp.access_point.regions[0].region #=> String
resp.access_point.regions[0]. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

  • :name (required, String) —

    The name of the Multi-Region Access Point whose configuration information you want to receive. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see [Rules for naming Amazon S3 Multi-Region Access Points] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming

Returns:

See Also:



4712
4713
4714
4715
 
# File 'lib/aws-sdk-s3control/client.rb', line 4712

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

#get_multi_region_access_point_policy(params = {}) ⇒ Types::GetMultiRegionAccessPointPolicyResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Returns the access control policy of the specified Multi-Region Access Point.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see [Multi-Region Access Point restrictions and limitations] in the *Amazon S3 User Guide*.

The following actions are related to ‘GetMultiRegionAccessPointPolicy`:

  • GetMultiRegionAccessPointPolicyStatus][2
  • PutMultiRegionAccessPointPolicy][3

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html

Examples:

Request syntax with placeholder values


resp = client.get_multi_region_access_point_policy({
  account_id: "AccountId",
  name: "MultiRegionAccessPointName", # required
})

Response structure


resp.policy.established.policy #=> String
resp.policy.proposed.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



4777
4778
4779
4780
 
# File 'lib/aws-sdk-s3control/client.rb', line 4777

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

#get_multi_region_access_point_policy_status(params = {}) ⇒ Types::GetMultiRegionAccessPointPolicyStatusResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see [Multi-Region Access Point restrictions and limitations] in the *Amazon S3 User Guide*.

The following actions are related to ‘GetMultiRegionAccessPointPolicyStatus`:

  • GetMultiRegionAccessPointPolicy][2
  • PutMultiRegionAccessPointPolicy][3

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html

Examples:

Request syntax with placeholder values


resp = client.get_multi_region_access_point_policy_status({
  account_id: "AccountId",
  name: "MultiRegionAccessPointName", # required
})

Response structure


resp.established.is_public #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



4841
4842
4843
4844
 
# File 'lib/aws-sdk-s3control/client.rb', line 4841

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

#get_multi_region_access_point_routes(params = {}) ⇒ Types::GetMultiRegionAccessPointRoutesResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.

To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:

  • ‘us-east-1`

  • ‘us-west-2`

  • ‘ap-southeast-2`

  • ‘ap-northeast-1`

  • ‘eu-west-1`

Examples:

Request syntax with placeholder values


resp = client.get_multi_region_access_point_routes({
  account_id: "AccountId",
  mrap: "MultiRegionAccessPointId", # required
})

Response structure


resp.mrap #=> String
resp.routes #=> Array
resp.routes[0].bucket #=> String
resp.routes[0].region #=> String
resp.routes[0].traffic_dial_percentage #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

  • :mrap (required, String) —

    The Multi-Region Access Point ARN.

Returns:

See Also:



4898
4899
4900
4901
 
# File 'lib/aws-sdk-s3control/client.rb', line 4898

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

#get_public_access_block(params = {}) ⇒ Types::GetPublicAccessBlockOutput

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Retrieves the ‘PublicAccessBlock` configuration for an Amazon Web Services account. This operation returns the effective account-level configuration, which may inherit from organization-level policies. For more information, see [ Using Amazon S3 block public access].

Related actions include:

  • DeletePublicAccessBlock][2
  • PutPublicAccessBlock][3

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html

Examples:

Request syntax with placeholder values


resp = client.get_public_access_block({
  account_id: "AccountId",
})

Response structure


resp.public_access_block_configuration.block_public_acls #=> Boolean
resp.public_access_block_configuration.ignore_public_acls #=> Boolean
resp.public_access_block_configuration.block_public_policy #=> Boolean
resp.public_access_block_configuration.restrict_public_buckets #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the Amazon Web Services account whose ‘PublicAccessBlock` configuration you want to retrieve.

Returns:

See Also:



4949
4950
4951
4952
 
# File 'lib/aws-sdk-s3control/client.rb', line 4949

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

#get_storage_lens_configuration(params = {}) ⇒ Types::GetStorageLensConfigurationResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Gets the Amazon S3 Storage Lens configuration. For more information, see [Assessing your storage activity and usage with Amazon S3 Storage Lens ][1] in the *Amazon S3 User Guide*. For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary] in the *Amazon S3 User Guide*.

<note markdown=“1”> To use this action, you must have permission to perform the ‘s3:GetStorageLensConfiguration` action. For more information, see

Setting permissions to use Amazon S3 Storage Lens][3

in the *Amazon

S3 User Guide*.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html

Examples:

Request syntax with placeholder values


resp = client.get_storage_lens_configuration({
  config_id: "ConfigId", # required
  account_id: "AccountId",
})

Response structure


resp.storage_lens_configuration.id #=> String
resp.storage_lens_configuration..activity_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration..bucket_level.activity_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration..bucket_level.prefix_level.storage_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration..bucket_level.prefix_level.storage_metrics.selection_criteria.delimiter #=> String
resp.storage_lens_configuration..bucket_level.prefix_level.storage_metrics.selection_criteria.max_depth #=> Integer
resp.storage_lens_configuration..bucket_level.prefix_level.storage_metrics.selection_criteria.min_storage_bytes_percentage #=> Float
resp.storage_lens_configuration..bucket_level.advanced_cost_optimization_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration..bucket_level.advanced_data_protection_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration..bucket_level.detailed_status_codes_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration..bucket_level.advanced_performance_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration..advanced_cost_optimization_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration..advanced_data_protection_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration..detailed_status_codes_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration..advanced_performance_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration..storage_lens_group_level.selection_criteria.include #=> Array
resp.storage_lens_configuration..storage_lens_group_level.selection_criteria.include[0] #=> String
resp.storage_lens_configuration..storage_lens_group_level.selection_criteria.exclude #=> Array
resp.storage_lens_configuration..storage_lens_group_level.selection_criteria.exclude[0] #=> String
resp.storage_lens_configuration.include.buckets #=> Array
resp.storage_lens_configuration.include.buckets[0] #=> String
resp.storage_lens_configuration.include.regions #=> Array
resp.storage_lens_configuration.include.regions[0] #=> String
resp.storage_lens_configuration.exclude.buckets #=> Array
resp.storage_lens_configuration.exclude.buckets[0] #=> String
resp.storage_lens_configuration.exclude.regions #=> Array
resp.storage_lens_configuration.exclude.regions[0] #=> String
resp.storage_lens_configuration.data_export.s3_bucket_destination.format #=> String, one of "CSV", "Parquet"
resp.storage_lens_configuration.data_export.s3_bucket_destination.output_schema_version #=> String, one of "V_1"
resp.storage_lens_configuration.data_export.s3_bucket_destination. #=> String
resp.storage_lens_configuration.data_export.s3_bucket_destination.arn #=> String
resp.storage_lens_configuration.data_export.s3_bucket_destination.prefix #=> String
resp.storage_lens_configuration.data_export.s3_bucket_destination.encryption.ssekms.key_id #=> String
resp.storage_lens_configuration.data_export.cloud_watch_metrics.is_enabled #=> Boolean
resp.storage_lens_configuration.data_export.storage_lens_table_destination.is_enabled #=> Boolean
resp.storage_lens_configuration.data_export.storage_lens_table_destination.encryption.ssekms.key_id #=> String
resp.storage_lens_configuration.expanded_prefixes_data_export.s3_bucket_destination.format #=> String, one of "CSV", "Parquet"
resp.storage_lens_configuration.expanded_prefixes_data_export.s3_bucket_destination.output_schema_version #=> String, one of "V_1"
resp.storage_lens_configuration.expanded_prefixes_data_export.s3_bucket_destination. #=> String
resp.storage_lens_configuration.expanded_prefixes_data_export.s3_bucket_destination.arn #=> String
resp.storage_lens_configuration.expanded_prefixes_data_export.s3_bucket_destination.prefix #=> String
resp.storage_lens_configuration.expanded_prefixes_data_export.s3_bucket_destination.encryption.ssekms.key_id #=> String
resp.storage_lens_configuration.expanded_prefixes_data_export.storage_lens_table_destination.is_enabled #=> Boolean
resp.storage_lens_configuration.expanded_prefixes_data_export.storage_lens_table_destination.encryption.ssekms.key_id #=> String
resp.storage_lens_configuration.is_enabled #=> Boolean
resp.storage_lens_configuration.aws_org.arn #=> String
resp.storage_lens_configuration.storage_lens_arn #=> String
resp.storage_lens_configuration.prefix_delimiter #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :config_id (required, String) —

    The ID of the Amazon S3 Storage Lens configuration.

  • :account_id (String) —

    The account ID of the requester.

Returns:

See Also:



5049
5050
5051
5052
 
# File 'lib/aws-sdk-s3control/client.rb', line 5049

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

#get_storage_lens_configuration_tagging(params = {}) ⇒ Types::GetStorageLensConfigurationTaggingResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see [Assessing your storage activity and usage with Amazon S3 Storage Lens ][1] in the *Amazon S3 User Guide*.

<note markdown=“1”> To use this action, you must have permission to perform the ‘s3:GetStorageLensConfigurationTagging` action. For more information, see [Setting permissions to use Amazon S3 Storage Lens] in the *Amazon S3 User Guide*.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html

Examples:

Request syntax with placeholder values


resp = client.get_storage_lens_configuration_tagging({
  config_id: "ConfigId", # required
  account_id: "AccountId",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :config_id (required, String) —

    The ID of the Amazon S3 Storage Lens configuration.

  • :account_id (String) —

    The account ID of the requester.

Returns:

See Also:



5102
5103
5104
5105
 
# File 'lib/aws-sdk-s3control/client.rb', line 5102

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

#get_storage_lens_group(params = {}) ⇒ Types::GetStorageLensGroupResult

Retrieves the Storage Lens group configuration details.

To use this operation, you must have the permission to perform the ‘s3:GetStorageLensGroup` action. For more information about the required Storage Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups].

For information about Storage Lens groups errors, see [List of Amazon S3 Storage Lens error codes].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions [2]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList

Examples:

Request syntax with placeholder values


resp = client.get_storage_lens_group({
  name: "StorageLensGroupName", # required
  account_id: "AccountId",
})

Response structure


resp.storage_lens_group.name #=> String
resp.storage_lens_group.filter.match_any_prefix #=> Array
resp.storage_lens_group.filter.match_any_prefix[0] #=> String
resp.storage_lens_group.filter.match_any_suffix #=> Array
resp.storage_lens_group.filter.match_any_suffix[0] #=> String
resp.storage_lens_group.filter.match_any_tag #=> Array
resp.storage_lens_group.filter.match_any_tag[0].key #=> String
resp.storage_lens_group.filter.match_any_tag[0].value #=> String
resp.storage_lens_group.filter.match_object_age.days_greater_than #=> Integer
resp.storage_lens_group.filter.match_object_age.days_less_than #=> Integer
resp.storage_lens_group.filter.match_object_size.bytes_greater_than #=> Integer
resp.storage_lens_group.filter.match_object_size.bytes_less_than #=> Integer
resp.storage_lens_group.filter.and.match_any_prefix #=> Array
resp.storage_lens_group.filter.and.match_any_prefix[0] #=> String
resp.storage_lens_group.filter.and.match_any_suffix #=> Array
resp.storage_lens_group.filter.and.match_any_suffix[0] #=> String
resp.storage_lens_group.filter.and.match_any_tag #=> Array
resp.storage_lens_group.filter.and.match_any_tag[0].key #=> String
resp.storage_lens_group.filter.and.match_any_tag[0].value #=> String
resp.storage_lens_group.filter.and.match_object_age.days_greater_than #=> Integer
resp.storage_lens_group.filter.and.match_object_age.days_less_than #=> Integer
resp.storage_lens_group.filter.and.match_object_size.bytes_greater_than #=> Integer
resp.storage_lens_group.filter.and.match_object_size.bytes_less_than #=> Integer
resp.storage_lens_group.filter.or.match_any_prefix #=> Array
resp.storage_lens_group.filter.or.match_any_prefix[0] #=> String
resp.storage_lens_group.filter.or.match_any_suffix #=> Array
resp.storage_lens_group.filter.or.match_any_suffix[0] #=> String
resp.storage_lens_group.filter.or.match_any_tag #=> Array
resp.storage_lens_group.filter.or.match_any_tag[0].key #=> String
resp.storage_lens_group.filter.or.match_any_tag[0].value #=> String
resp.storage_lens_group.filter.or.match_object_age.days_greater_than #=> Integer
resp.storage_lens_group.filter.or.match_object_age.days_less_than #=> Integer
resp.storage_lens_group.filter.or.match_object_size.bytes_greater_than #=> Integer
resp.storage_lens_group.filter.or.match_object_size.bytes_less_than #=> Integer
resp.storage_lens_group.storage_lens_group_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Storage Lens group that you’re trying to retrieve the configuration details for.

  • :account_id (String) —

    The Amazon Web Services account ID associated with the Storage Lens group that you’re trying to retrieve the details for.

Returns:

See Also:



5183
5184
5185
5186
 
# File 'lib/aws-sdk-s3control/client.rb', line 5183

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

#list_access_grants(params = {}) ⇒ Types::ListAccessGrantsResult

Returns the list of access grants in your S3 Access Grants instance.

Permissions

: You must have the ‘s3:ListAccessGrants` permission to use this

operation.

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_grants({
  account_id: "AccountId",
  next_token: "ContinuationToken",
  max_results: 1,
  grantee_type: "DIRECTORY_USER", # accepts DIRECTORY_USER, DIRECTORY_GROUP, IAM
  grantee_identifier: "GranteeIdentifier",
  permission: "READ", # accepts READ, WRITE, READWRITE
  grant_scope: "S3Prefix",
  application_arn: "IdentityCenterApplicationArn",
})

Response structure


resp.next_token #=> String
resp.access_grants_list #=> Array
resp.access_grants_list[0].created_at #=> Time
resp.access_grants_list[0].access_grant_id #=> String
resp.access_grants_list[0].access_grant_arn #=> String
resp.access_grants_list[0].grantee.grantee_type #=> String, one of "DIRECTORY_USER", "DIRECTORY_GROUP", "IAM"
resp.access_grants_list[0].grantee.grantee_identifier #=> String
resp.access_grants_list[0].permission #=> String, one of "READ", "WRITE", "READWRITE"
resp.access_grants_list[0].access_grants_location_id #=> String
resp.access_grants_list[0].access_grants_location_configuration.s3_sub_prefix #=> String
resp.access_grants_list[0].grant_scope #=> String
resp.access_grants_list[0].application_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :next_token (String) —

    A pagination token to request the next page of results. Pass this value into a subsequent ‘List Access Grants` request in order to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of access grants that you would like returned in the ‘List Access Grants` response. If the results include the pagination token `NextToken`, make another call using the `NextToken` to determine if there are more results.

  • :grantee_type (String) —

    The type of the grantee to which access has been granted. It can be one of the following values:

    • ‘IAM` - An IAM user or role.

    • ‘DIRECTORY_USER` - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

    • ‘DIRECTORY_GROUP` - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

  • :grantee_identifier (String) —

    The unique identifer of the ‘Grantee`. If the grantee type is `IAM`, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.

  • :permission (String) —

    The type of permission granted to your S3 data, which can be set to one of the following values:

    • ‘READ` – Grant read-only access to the S3 data.

    • ‘WRITE` – Grant write-only access to the S3 data.

    • ‘READWRITE` – Grant both read and write access to the S3 data.

  • :grant_scope (String) —

    The S3 path of the data to which you are granting access. It is the result of appending the ‘Subprefix` to the location scope.

  • :application_arn (String) —

    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

Returns:

See Also:



5292
5293
5294
5295
 
# File 'lib/aws-sdk-s3control/client.rb', line 5292

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

#list_access_grants_instances(params = {}) ⇒ Types::ListAccessGrantsInstancesResult

Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have one S3 Access Grants instance per Region per account.

Permissions

: You must have the ‘s3:ListAccessGrantsInstances` permission to use

this operation.

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_grants_instances({
  account_id: "AccountId",
  next_token: "ContinuationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.access_grants_instances_list #=> Array
resp.access_grants_instances_list[0].access_grants_instance_id #=> String
resp.access_grants_instances_list[0].access_grants_instance_arn #=> String
resp.access_grants_instances_list[0].created_at #=> Time
resp.access_grants_instances_list[0].identity_center_arn #=> String
resp.access_grants_instances_list[0].identity_center_instance_arn #=> String
resp.access_grants_instances_list[0].identity_center_application_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :next_token (String) —

    A pagination token to request the next page of results. Pass this value into a subsequent ‘List Access Grants Instances` request in order to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of access grants that you would like returned in the ‘List Access Grants` response. If the results include the pagination token `NextToken`, make another call using the `NextToken` to determine if there are more results.

Returns:

See Also:



5351
5352
5353
5354
 
# File 'lib/aws-sdk-s3control/client.rb', line 5351

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

#list_access_grants_locations(params = {}) ⇒ Types::ListAccessGrantsLocationsResult

Returns a list of the locations registered in your S3 Access Grants instance.

Permissions

: You must have the ‘s3:ListAccessGrantsLocations` permission to use

this operation.

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_grants_locations({
  account_id: "AccountId",
  next_token: "ContinuationToken",
  max_results: 1,
  location_scope: "S3Prefix",
})

Response structure


resp.next_token #=> String
resp.access_grants_locations_list #=> Array
resp.access_grants_locations_list[0].created_at #=> Time
resp.access_grants_locations_list[0].access_grants_location_id #=> String
resp.access_grants_locations_list[0].access_grants_location_arn #=> String
resp.access_grants_locations_list[0].location_scope #=> String
resp.access_grants_locations_list[0].iam_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :next_token (String) —

    A pagination token to request the next page of results. Pass this value into a subsequent ‘List Access Grants Locations` request in order to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of access grants that you would like returned in the ‘List Access Grants` response. If the results include the pagination token `NextToken`, make another call using the `NextToken` to determine if there are more results.

  • :location_scope (String) —

    The S3 path to the location that you are registering. The location scope can be the default S3 location ‘s3://`, the S3 path to a bucket `s3://<bucket>`, or the S3 path to a bucket and prefix `s3://<bucket>/<prefix>`. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the `engineering/` prefix or object key names that start with the `marketing/campaigns/` prefix.

Returns:

See Also:



5418
5419
5420
5421
 
# File 'lib/aws-sdk-s3control/client.rb', line 5418

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

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

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Returns a list of the access points. You can retrieve up to 1,000 access points per call. If the call returns more than 1,000 access points (or the number specified in ‘maxResults`, whichever is less), the response will include a continuation token that you can use to list the additional access points.

Returns only access points attached to S3 buckets by default. To return all access points specify ‘DataSourceType` as `ALL`.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘ListAccessPoints`:

  • CreateAccessPoint][2
  • DeleteAccessPoint][3
  • GetAccessPoint][4

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html

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({
  account_id: "AccountId",
  bucket: "BucketName",
  next_token: "NonEmptyMaxLength1024String",
  max_results: 1,
  data_source_id: "DataSourceId",
  data_source_type: "DataSourceType",
})

Response structure


resp.access_point_list #=> Array
resp.access_point_list[0].name #=> String
resp.access_point_list[0].network_origin #=> String, one of "Internet", "VPC"
resp.access_point_list[0].vpc_configuration.vpc_id #=> String
resp.access_point_list[0].bucket #=> String
resp.access_point_list[0].access_point_arn #=> String
resp.access_point_list[0].alias #=> String
resp.access_point_list[0]. #=> String
resp.access_point_list[0].data_source_id #=> String
resp.access_point_list[0].data_source_type #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the account that owns the specified access points.

  • :bucket (String) —

    The name of the bucket whose associated access points you want to list.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

  • :next_token (String) —

    A continuation token. If a previous call to ‘ListAccessPoints` returned a continuation token in the `NextToken` field, then providing that value here causes Amazon S3 to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the ‘NextToken` field that you can use to retrieve the next page of access points.

  • :data_source_id (String) —

    The unique identifier for the data source of the access point.

  • :data_source_type (String) —

    The type of the data source that the access point is attached to. Returns only access points attached to S3 buckets by default. To return all access points specify ‘DataSourceType` as `ALL`.

Returns:

See Also:



5538
5539
5540
5541
 
# File 'lib/aws-sdk-s3control/client.rb', line 5538

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

#list_access_points_for_directory_buckets(params = {}) ⇒ Types::ListAccessPointsForDirectoryBucketsResult

Returns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket.

To list access points for general purpose buckets, see [ListAccesspoints].

To use this operation, you must have the permission to perform the ‘s3express:ListAccessPointsForDirectoryBuckets` action.

For information about REST API errors, see [REST error responses].

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses

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_for_directory_buckets({
  account_id: "AccountId", # required
  directory_bucket: "BucketName",
  next_token: "NonEmptyMaxLength1024String",
  max_results: 1,
})

Response structure


resp.access_point_list #=> Array
resp.access_point_list[0].name #=> String
resp.access_point_list[0].network_origin #=> String, one of "Internet", "VPC"
resp.access_point_list[0].vpc_configuration.vpc_id #=> String
resp.access_point_list[0].bucket #=> String
resp.access_point_list[0].access_point_arn #=> String
resp.access_point_list[0].alias #=> String
resp.access_point_list[0]. #=> String
resp.access_point_list[0].data_source_id #=> String
resp.access_point_list[0].data_source_type #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Web Services account ID that owns the access points.

  • :directory_bucket (String) —

    The name of the directory bucket associated with the access points you want to list.

  • :next_token (String) —

    If ‘NextToken` is returned, there are more access points available than requested in the `maxResults` value. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

  • :max_results (Integer) —

    The maximum number of access points that you would like returned in the ‘ListAccessPointsForDirectoryBuckets` response. If the directory bucket is associated with more than this number of access points, the results include the pagination token `NextToken`. Make another call using the `NextToken` to retrieve more results.

Returns:

See Also:



5615
5616
5617
5618
 
# File 'lib/aws-sdk-s3control/client.rb', line 5615

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

#list_access_points_for_object_lambda(params = {}) ⇒ Types::ListAccessPointsForObjectLambdaResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.

The following actions are related to ‘ListAccessPointsForObjectLambda`:

  • CreateAccessPointForObjectLambda][1
  • DeleteAccessPointForObjectLambda][2
  • GetAccessPointForObjectLambda][3

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html

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_for_object_lambda({
  account_id: "AccountId",
  next_token: "NonEmptyMaxLength1024String",
  max_results: 1,
})

Response structure


resp.object_lambda_access_point_list #=> Array
resp.object_lambda_access_point_list[0].name #=> String
resp.object_lambda_access_point_list[0].object_lambda_access_point_arn #=> String
resp.object_lambda_access_point_list[0].alias.value #=> String
resp.object_lambda_access_point_list[0].alias.status #=> String, one of "PROVISIONING", "READY"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified Object Lambda Access Point.

  • :next_token (String) —

    If the list has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

  • :max_results (Integer) —

    The maximum number of access points that you want to include in the list. The response may contain fewer access points but will never contain more. If there are more than this number of access points, then the response will include a continuation token in the ‘NextToken` field that you can use to retrieve the next page of access points.

Returns:

See Also:



5690
5691
5692
5693
 
# File 'lib/aws-sdk-s3control/client.rb', line 5690

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

#list_caller_access_grants(params = {}) ⇒ Types::ListCallerAccessGrantsResult

Use this API to list the access grants that grant the caller access to Amazon S3 data through S3 Access Grants. The caller (grantee) can be an Identity and Access Management (IAM) identity or Amazon Web Services Identity Center corporate directory identity. You must pass the Amazon Web Services account of the S3 data owner (grantor) in the request. You can, optionally, narrow the results by ‘GrantScope`, using a fragment of the data’s S3 path, and S3 Access Grants will return only the grants with a path that contains the path fragment. You can also pass the ‘AllowedByApplication` filter in the request, which returns only the grants authorized for applications, whether the application is the caller’s Identity Center application or any other application (‘ALL`). For more information, see [List the caller’s access grants] in the *Amazon S3 User Guide*.

Permissions

: You must have the ‘s3:ListCallerAccessGrants` permission to use this

operation.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-list-grants.html

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_caller_access_grants({
  account_id: "AccountId",
  grant_scope: "S3Prefix",
  next_token: "ContinuationToken",
  max_results: 1,
  allowed_by_application: false,
})

Response structure


resp.next_token #=> String
resp.caller_access_grants_list #=> Array
resp.caller_access_grants_list[0].permission #=> String, one of "READ", "WRITE", "READWRITE"
resp.caller_access_grants_list[0].grant_scope #=> String
resp.caller_access_grants_list[0].application_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :grant_scope (String) —

    The S3 path of the data that you would like to access. Must start with ‘s3://`. You can optionally pass only the beginning characters of a path, and S3 Access Grants will search for all applicable grants for the path fragment.

  • :next_token (String) —

    A pagination token to request the next page of results. Pass this value into a subsequent ‘List Caller Access Grants` request in order to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of access grants that you would like returned in the ‘List Caller Access Grants` response. If the results include the pagination token `NextToken`, make another call using the `NextToken` to determine if there are more results.

  • :allowed_by_application (Boolean) —

    If this optional parameter is passed in the request, a filter is applied to the results. The results will include only the access grants for the caller’s Identity Center application or for any other applications (‘ALL`).

Returns:

See Also:



5773
5774
5775
5776
 
# File 'lib/aws-sdk-s3control/client.rb', line 5773

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

#list_jobs(params = {}) ⇒ Types::ListJobsResult

Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request. For more information, see [S3 Batch Operations] in the *Amazon S3 User Guide*.

Permissions

: To use the ‘ListJobs` operation, you must have permission to perform

the `s3:ListJobs` action.

Related actions include:

  • CreateJob][2
  • DescribeJob][3
  • UpdateJobPriority][4
  • UpdateJobStatus][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html

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_jobs({
  account_id: "AccountId",
  job_statuses: ["Active"], # accepts Active, Cancelled, Cancelling, Complete, Completing, Failed, Failing, New, Paused, Pausing, Preparing, Ready, Suspended
  next_token: "StringForNextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.jobs #=> Array
resp.jobs[0].job_id #=> String
resp.jobs[0].description #=> String
resp.jobs[0].operation #=> String, one of "LambdaInvoke", "S3PutObjectCopy", "S3PutObjectAcl", "S3PutObjectTagging", "S3DeleteObjectTagging", "S3InitiateRestoreObject", "S3PutObjectLegalHold", "S3PutObjectRetention", "S3ReplicateObject", "S3ComputeObjectChecksum"
resp.jobs[0].priority #=> Integer
resp.jobs[0].status #=> String, one of "Active", "Cancelled", "Cancelling", "Complete", "Completing", "Failed", "Failing", "New", "Paused", "Pausing", "Preparing", "Ready", "Suspended"
resp.jobs[0].creation_time #=> Time
resp.jobs[0].termination_date #=> Time
resp.jobs[0].progress_summary.total_number_of_tasks #=> Integer
resp.jobs[0].progress_summary.number_of_tasks_succeeded #=> Integer
resp.jobs[0].progress_summary.number_of_tasks_failed #=> Integer
resp.jobs[0].progress_summary.timers.elapsed_time_in_active_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

  • :job_statuses (Array<String>) —

    The ‘List Jobs` request returns jobs that match the statuses listed in this element.

  • :next_token (String) —

    A pagination token to request the next page of results. Use the token that Amazon S3 returned in the ‘NextToken` element of the `ListJobsResult` from the previous `List Jobs` request.

  • :max_results (Integer) —

    The maximum number of jobs that Amazon S3 will include in the ‘List Jobs` response. If there are more jobs than this number, the response will include a pagination token in the `NextToken` field to enable you to retrieve the next page of results.

Returns:

See Also:



5863
5864
5865
5866
 
# File 'lib/aws-sdk-s3control/client.rb', line 5863

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

#list_multi_region_access_points(params = {}) ⇒ Types::ListMultiRegionAccessPointsResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see [Multi-Region Access Point restrictions and limitations] in the *Amazon S3 User Guide*.

The following actions are related to ‘ListMultiRegionAccessPoint`:

  • CreateMultiRegionAccessPoint][2
  • DeleteMultiRegionAccessPoint][3
  • DescribeMultiRegionAccessPointOperation][4
  • GetMultiRegionAccessPoint][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html

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_multi_region_access_points({
  account_id: "AccountId",
  next_token: "NonEmptyMaxLength1024String",
  max_results: 1,
})

Response structure


resp.access_points #=> Array
resp.access_points[0].name #=> String
resp.access_points[0].alias #=> String
resp.access_points[0].created_at #=> Time
resp.access_points[0].public_access_block.block_public_acls #=> Boolean
resp.access_points[0].public_access_block.ignore_public_acls #=> Boolean
resp.access_points[0].public_access_block.block_public_policy #=> Boolean
resp.access_points[0].public_access_block.restrict_public_buckets #=> Boolean
resp.access_points[0].status #=> String, one of "READY", "INCONSISTENT_ACROSS_REGIONS", "CREATING", "PARTIALLY_CREATED", "PARTIALLY_DELETED", "DELETING"
resp.access_points[0].regions #=> Array
resp.access_points[0].regions[0].bucket #=> String
resp.access_points[0].regions[0].region #=> String
resp.access_points[0].regions[0]. #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

  • :next_token (String) —

    Not currently used. Do not use this parameter.

  • :max_results (Integer) —

    Not currently used. Do not use this parameter.

Returns:

See Also:



5947
5948
5949
5950
 
# File 'lib/aws-sdk-s3control/client.rb', line 5947

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

#list_regional_buckets(params = {}) ⇒ Types::ListRegionalBucketsResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see

Using Amazon S3 on Outposts][1

in the *Amazon S3 User Guide*.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and ‘x-amz-outpost-id` in your request, see the [Examples] section.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples

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_regional_buckets({
  account_id: "AccountId",
  next_token: "NonEmptyMaxLength1024String",
  max_results: 1,
  outpost_id: "NonEmptyMaxLength64String",
})

Response structure


resp.regional_bucket_list #=> Array
resp.regional_bucket_list[0].bucket #=> String
resp.regional_bucket_list[0].bucket_arn #=> String
resp.regional_bucket_list[0].public_access_block_enabled #=> Boolean
resp.regional_bucket_list[0].creation_date #=> Time
resp.regional_bucket_list[0].outpost_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket.

  • :next_token (String)
  • :max_results (Integer)
  • :outpost_id (String) —

    The ID of the Outposts resource.

    <note markdown=“1”> This ID is required by Amazon S3 on Outposts buckets.

    </note>

Returns:

See Also:



6013
6014
6015
6016
 
# File 'lib/aws-sdk-s3control/client.rb', line 6013

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

#list_storage_lens_configurations(params = {}) ⇒ Types::ListStorageLensConfigurationsResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see [Assessing your storage activity and usage with Amazon S3 Storage Lens ][1] in the *Amazon S3 User Guide*.

<note markdown=“1”> To use this action, you must have permission to perform the ‘s3:ListStorageLensConfigurations` action. For more information, see

Setting permissions to use Amazon S3 Storage Lens][2

in the *Amazon

S3 User Guide*.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html

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_storage_lens_configurations({
  account_id: "AccountId",
  next_token: "ContinuationToken",
})

Response structure


resp.next_token #=> String
resp.storage_lens_configuration_list #=> Array
resp.storage_lens_configuration_list[0].id #=> String
resp.storage_lens_configuration_list[0].storage_lens_arn #=> String
resp.storage_lens_configuration_list[0].home_region #=> String
resp.storage_lens_configuration_list[0].is_enabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID of the requester.

  • :next_token (String) —

    A pagination token to request the next page of results.

Returns:

See Also:



6072
6073
6074
6075
 
# File 'lib/aws-sdk-s3control/client.rb', line 6072

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

#list_storage_lens_groups(params = {}) ⇒ Types::ListStorageLensGroupsResult

Lists all the Storage Lens groups in the specified home Region.

To use this operation, you must have the permission to perform the ‘s3:ListStorageLensGroups` action. For more information about the required Storage Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups].

For information about Storage Lens groups errors, see [List of Amazon S3 Storage Lens error codes].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions [2]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList

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_storage_lens_groups({
  account_id: "AccountId",
  next_token: "ContinuationToken",
})

Response structure


resp.next_token #=> String
resp.storage_lens_group_list #=> Array
resp.storage_lens_group_list[0].name #=> String
resp.storage_lens_group_list[0].storage_lens_group_arn #=> String
resp.storage_lens_group_list[0].home_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID that owns the Storage Lens groups.

  • :next_token (String) —

    The token for the next set of results, or ‘null` if there are no more results.

Returns:

See Also:



6125
6126
6127
6128
 
# File 'lib/aws-sdk-s3control/client.rb', line 6125

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

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

This operation allows you to list all of the tags for a specified resource. Each tag is a label consisting of a key and value. Tags can help you organize, track costs for, and control access to resources.

<note markdown=“1”> This operation is only supported for the following Amazon S3 resources:

* [General purpose buckets][1]
  • Access Points for directory buckets][2
  • Access Points for general purpose buckets][3
  • Directory buckets][4
  • S3 Storage Lens groups][5

  • [S3 Access Grants instances, registered locations, and grants].

</note>

Permissions

: For general purpose buckets, access points for general purpose

buckets, Storage Lens groups, and S3 Access Grants, you must have
the `s3:ListTagsForResource` permission to use this operation.

Directory bucket permissions

: For directory buckets, you must have the

`s3express:ListTagsForResource` permission to use this operation.
For more information about directory buckets policies and
permissions, see [Identity and Access Management (IAM) for S3
Express One Zone][7] in the *Amazon S3 User Guide*.

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is

`s3express-control.region.amazonaws.com`.

For information about S3 Tagging errors, see [List of Amazon S3 Tagging error codes].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-db-tagging.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-tagging.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html [6]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html [7]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-permissions.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  account_id: "AccountId",
  resource_arn: "S3ResourceArn", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the resource owner.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the S3 resource that you want to list tags for. The tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.

Returns:

See Also:



6214
6215
6216
6217
 
# File 'lib/aws-sdk-s3control/client.rb', line 6214

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

#put_access_grants_instance_resource_policy(params = {}) ⇒ Types::PutAccessGrantsInstanceResourcePolicyResult

Updates the resource policy of the S3 Access Grants instance.

Permissions

: You must have the ‘s3:PutAccessGrantsInstanceResourcePolicy`

permission to use this operation.

Examples:

Request syntax with placeholder values


resp = client.put_access_grants_instance_resource_policy({
  account_id: "AccountId",
  policy: "PolicyDocument", # required
  organization: "Organization",
})

Response structure


resp.policy #=> String
resp.organization #=> String
resp.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :policy (required, String) —

    The resource policy of the S3 Access Grants instance that you are updating.

  • :organization (String) —

    The Organization of the resource policy of the S3 Access Grants instance.

Returns:

See Also:



6261
6262
6263
6264
 
# File 'lib/aws-sdk-s3control/client.rb', line 6261

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

#put_access_point_configuration_for_object_lambda(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Replaces configuration for an Object Lambda Access Point.

The following actions are related to ‘PutAccessPointConfigurationForObjectLambda`:

  • GetAccessPointConfigurationForObjectLambda][1

^

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointConfigurationForObjectLambda.html

Examples:

Request syntax with placeholder values


resp = client.put_access_point_configuration_for_object_lambda({
  account_id: "AccountId",
  name: "ObjectLambdaAccessPointName", # required
  configuration: { # required
    supporting_access_point: "ObjectLambdaSupportingAccessPointArn", # required
    cloud_watch_metrics_enabled: false,
    allowed_features: ["GetObject-Range"], # accepts GetObject-Range, GetObject-PartNumber, HeadObject-Range, HeadObject-PartNumber
    transformation_configurations: [ # required
      {
        actions: ["GetObject"], # required, accepts GetObject, HeadObject, ListObjects, ListObjectsV2
        content_transformation: { # required
          aws_lambda: {
            function_arn: "FunctionArnString", # required
            function_payload: "AwsLambdaTransformationPayload",
          },
        },
      },
    ],
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified Object Lambda Access Point.

  • :name (required, String) —

    The name of the Object Lambda Access Point.

  • :configuration (required, Types::ObjectLambdaConfiguration) —

    Object Lambda Access Point configuration document.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6322
6323
6324
6325
 
# File 'lib/aws-sdk-s3control/client.rb', line 6322

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

#put_access_point_policy(params = {}) ⇒ Struct

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘PutAccessPointPolicy`:

  • GetAccessPointPolicy][2
  • DeleteAccessPointPolicy][3

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html

Examples:

Request syntax with placeholder values


resp = client.put_access_point_policy({
  account_id: "AccountId",
  name: "AccessPointName", # required
  policy: "Policy", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for owner of the bucket associated with the specified access point.

  • :name (required, String) —

    The name of the access point that you want to associate with the specified policy.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>`. For example, to access the access point `reports-ap` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap`. The value must be URL encoded.

  • :policy (required, String) —

    The policy that you want to apply to the specified access point. For more information about access point policies, see [Managing data access with Amazon S3 access points] or [Managing access to shared datasets in directory buckets with access points] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6401
6402
6403
6404
 
# File 'lib/aws-sdk-s3control/client.rb', line 6401

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

#put_access_point_policy_for_object_lambda(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see [Creating Object Lambda Access Points] in the *Amazon S3 User Guide*.

The following actions are related to ‘PutAccessPointPolicyForObjectLambda`:

  • DeleteAccessPointPolicyForObjectLambda][2
  • GetAccessPointPolicyForObjectLambda][3

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/olap-create.html#olap-create-cli [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html

Examples:

Request syntax with placeholder values


resp = client.put_access_point_policy_for_object_lambda({
  account_id: "AccountId",
  name: "ObjectLambdaAccessPointName", # required
  policy: "ObjectLambdaPolicy", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The account ID for the account that owns the specified Object Lambda Access Point.

  • :name (required, String) —

    The name of the Object Lambda Access Point.

  • :policy (required, String) —

    Object Lambda Access Point resource policy document.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6451
6452
6453
6454
 
# File 'lib/aws-sdk-s3control/client.rb', line 6451

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

#put_access_point_scope(params = {}) ⇒ Struct

Creates or replaces the access point scope for a directory bucket. You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.

<note markdown=“1”> You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.

</note>

To use this operation, you must have the permission to perform the ‘s3express:PutAccessPointScope` action.

For information about REST API errors, see [REST error responses].

[1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses

Examples:

Request syntax with placeholder values


resp = client.put_access_point_scope({
  account_id: "AccountId", # required
  name: "AccessPointName", # required
  scope: { # required
    prefixes: ["Prefix"],
    permissions: ["GetObject"], # accepts GetObject, GetObjectAttributes, ListMultipartUploadParts, ListBucket, ListBucketMultipartUploads, PutObject, DeleteObject, AbortMultipartUpload
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Web Services account ID that owns the access point with scope that you want to create or replace.

  • :name (required, String) —

    The name of the access point with the scope that you want to create or replace.

  • :scope (required, Types::Scope) —

    Object prefixes, API operations, or a combination of both.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6502
6503
6504
6505
 
# File 'lib/aws-sdk-s3control/client.rb', line 6502

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

#put_bucket_lifecycle_configuration(params = {}) ⇒ Struct

<note markdown=“1”> This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see

PutBucketLifecycleConfiguration][1

in the *Amazon S3 API Reference*.

</note>

Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘PutBucketLifecycleConfiguration`:

  • GetBucketLifecycleConfiguration][3
  • DeleteBucketLifecycleConfiguration][4

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html

Examples:

Request syntax with placeholder values


resp = client.put_bucket_lifecycle_configuration({
  account_id: "AccountId",
  bucket: "BucketName", # required
  lifecycle_configuration: {
    rules: [
      {
        expiration: {
          date: Time.now,
          days: 1,
          expired_object_delete_marker: false,
        },
        id: "ID",
        filter: {
          prefix: "Prefix",
          tag: {
            key: "TagKeyString", # required
            value: "TagValueString", # required
          },
          and: {
            prefix: "Prefix",
            tags: [
              {
                key: "TagKeyString", # required
                value: "TagValueString", # required
              },
            ],
            object_size_greater_than: 1,
            object_size_less_than: 1,
          },
          object_size_greater_than: 1,
          object_size_less_than: 1,
        },
        status: "Enabled", # required, accepts Enabled, Disabled
        transitions: [
          {
            date: Time.now,
            days: 1,
            storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE
          },
        ],
        noncurrent_version_transitions: [
          {
            noncurrent_days: 1,
            storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE
          },
        ],
        noncurrent_version_expiration: {
          noncurrent_days: 1,
          newer_noncurrent_versions: 1,
        },
        abort_incomplete_multipart_upload: {
          days_after_initiation: 1,
        },
      },
    ],
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket.

  • :bucket (required, String) —

    The name of the bucket for which to set the configuration.

  • :lifecycle_configuration (Types::LifecycleConfiguration) —

    Container for lifecycle rules. You can add as many as 1,000 rules.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6617
6618
6619
6620
 
# File 'lib/aws-sdk-s3control/client.rb', line 6617

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

#put_bucket_policy(params = {}) ⇒ Struct

<note markdown=“1”> This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see [PutBucketPolicy] in the *Amazon S3 API Reference*.

</note>

Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see [Using Amazon S3 on Outposts] in the *Amazon S3 User Guide*.

If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the ‘PutBucketPolicy` permissions on the specified Outposts bucket and belong to the bucket owner’s account in order to use this action.

If you don’t have ‘PutBucketPolicy` permissions, Amazon S3 returns a `403 Access Denied` error. If you have the correct permissions, but you’re not using an identity that belongs to the bucket owner’s account, Amazon S3 returns a ‘405 Method Not Allowed` error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see [Using Bucket Policies and User Policies].

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘PutBucketPolicy`:

  • GetBucketPolicy][5
  • DeleteBucketPolicy][6

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html

Examples:

Request syntax with placeholder values


resp = client.put_bucket_policy({
  account_id: "AccountId",
  bucket: "BucketName", # required
  confirm_remove_self_bucket_access: false,
  policy: "Policy", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket.

  • :bucket (required, String) —

    Specifies the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

  • :confirm_remove_self_bucket_access (Boolean) —

    Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

    <note markdown=“1”> This is not supported by Amazon S3 on Outposts buckets.

    </note>
  • :policy (required, String) —

    The bucket policy as a JSON document.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6719
6720
6721
6722
 
# File 'lib/aws-sdk-s3control/client.rb', line 6719

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

#put_bucket_replication(params = {}) ⇒ Struct

<note markdown=“1”> This action creates an Amazon S3 on Outposts bucket’s replication configuration. To create an S3 bucket’s replication configuration, see [PutBucketReplication] in the *Amazon S3 API Reference*.

</note>

Creates a replication configuration or replaces an existing one. For information about S3 replication on Outposts configuration, see

Replicating objects for S3 on Outposts][2

in the *Amazon S3 User

Guide*.

<note markdown=“1”> It can take a while to propagate ‘PUT` or `DELETE` requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that’s returned by a ‘GET` request soon after a `PUT` or `DELETE` request might return a more recent result than what’s on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.

</note>

Specify the replication configuration in the request body. In the replication configuration, you provide the following information:

  • The name of the destination bucket or buckets where you want S3 on Outposts to replicate objects

  • The Identity and Access Management (IAM) role that S3 on Outposts can assume to replicate objects on your behalf

  • Other relevant information, such as replication rules

A replication configuration must include at least one rule and can contain a maximum of 100. Each rule identifies a subset of objects to replicate by filtering the objects in the source Outposts bucket. To choose additional subsets of objects to replicate, add a rule for each subset.

To specify a subset of the objects in the source Outposts bucket to apply a replication rule to, add the ‘Filter` element as a child of the `Rule` element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the `Filter` element in the configuration, you must also add the following elements: `DeleteMarkerReplication`, `Status`, and `Priority`.

Using ‘PutBucketReplication` on Outposts requires that both the source and destination buckets must have versioning enabled. For information about enabling versioning on a bucket, see [Managing S3 Versioning for your S3 on Outposts bucket].

For information about S3 on Outposts replication failure reasons, see

Replication failure reasons][4

in the *Amazon S3 User Guide*.

**Handling Replication of Encrypted Objects**

Outposts buckets are encrypted at all times. All the objects in the source Outposts bucket are encrypted and can be replicated. Also, all the replicas in the destination Outposts bucket are encrypted with the same encryption key as the objects in the source Outposts bucket.

Permissions

To create a ‘PutBucketReplication` request, you must have `s3-outposts:PutReplicationConfiguration` permissions for the bucket. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see [Setting up IAM with S3 on Outposts] and [Managing access to S3 on Outposts buckets].

<note markdown=“1”> To perform this operation, the user or role must also have the ‘iam:CreateRole` and `iam:PassRole` permissions. For more information, see [Granting a user permissions to pass a role to an Amazon Web Services service].

</note>

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following operations are related to ‘PutBucketReplication`:

  • GetBucketReplication][9
  • DeleteBucketReplication][10

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsManagingVersioning.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-eventbridge.html#outposts-replication-failure-codes [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html [6]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html [7]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html#API_control_PutBucketReplication_Examples [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html

Examples:

Request syntax with placeholder values


resp = client.put_bucket_replication({
  account_id: "AccountId",
  bucket: "BucketName", # required
  replication_configuration: { # required
    role: "Role", # required
    rules: [ # required
      {
        id: "ID",
        priority: 1,
        prefix: "Prefix",
        filter: {
          prefix: "Prefix",
          tag: {
            key: "TagKeyString", # required
            value: "TagValueString", # required
          },
          and: {
            prefix: "Prefix",
            tags: [
              {
                key: "TagKeyString", # required
                value: "TagValueString", # required
              },
            ],
          },
        },
        status: "Enabled", # required, accepts Enabled, Disabled
        source_selection_criteria: {
          sse_kms_encrypted_objects: {
            status: "Enabled", # required, accepts Enabled, Disabled
          },
          replica_modifications: {
            status: "Enabled", # required, accepts Enabled, Disabled
          },
        },
        existing_object_replication: {
          status: "Enabled", # required, accepts Enabled, Disabled
        },
        destination: { # required
          account: "AccountId",
          bucket: "BucketIdentifierString", # required
          replication_time: {
            status: "Enabled", # required, accepts Enabled, Disabled
            time: { # required
              minutes: 1,
            },
          },
          access_control_translation: {
            owner: "Destination", # required, accepts Destination
          },
          encryption_configuration: {
            replica_kms_key_id: "ReplicaKmsKeyID",
          },
          metrics: {
            status: "Enabled", # required, accepts Enabled, Disabled
            event_threshold: {
              minutes: 1,
            },
          },
          storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR
        },
        delete_marker_replication: {
          status: "Enabled", # required, accepts Enabled, Disabled
        },
        bucket: "BucketIdentifierString", # required
      },
    ],
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket.

  • :bucket (required, String) —

    Specifies the S3 on Outposts bucket to set the configuration for.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

  • :replication_configuration (required, Types::ReplicationConfiguration)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6926
6927
6928
6929
 
# File 'lib/aws-sdk-s3control/client.rb', line 6926

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

#put_bucket_tagging(params = {}) ⇒ Struct

<note markdown=“1”> This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see [PutBucketTagging] in the *Amazon S3 API Reference*.

</note>

Sets the tags for an S3 on Outposts bucket. For more information, see

Using Amazon S3 on Outposts][2

in the *Amazon S3 User Guide*.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see [Cost allocation and tagging].

<note markdown=“1”> Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see [ Using cost allocation in Amazon S3 bucket tags].

</note>

To use this action, you must have permissions to perform the ‘s3-outposts:PutBucketTagging` action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see [ Permissions Related to Bucket Subresource Operations] and [Managing access permissions to your Amazon S3 resources].

‘PutBucketTagging` has the following special errors:

  • Error code: ‘InvalidTagError`

    • Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see [ User-Defined Tag Restrictions] and [ Amazon Web Services-Generated Cost Allocation Tag Restrictions].

    ^

  • Error code: ‘MalformedXMLError`

    • Description: The XML provided does not match the schema.

    ^

  • Error code: ‘OperationAbortedError `

    • Description: A conflicting conditional action is currently in progress against this resource. Try again.

    ^

  • Error code: ‘InternalError`

    • Description: The service was unable to apply the provided tag to the bucket.

    ^

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following actions are related to ‘PutBucketTagging`:

  • GetBucketTagging][10
  • DeleteBucketTagging][11

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [3]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [6]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [7]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html [8]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html [11]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html

Examples:

Request syntax with placeholder values


resp = client.put_bucket_tagging({
  account_id: "AccountId",
  bucket: "BucketName", # required
  tagging: { # required
    tag_set: [ # required
      {
        key: "TagKeyString", # required
        value: "TagValueString", # required
      },
    ],
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the Outposts bucket.

  • :bucket (required, String) —

    The Amazon Resource Name (ARN) of the bucket.

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.

  • :tagging (required, Types::Tagging)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7062
7063
7064
7065
 
# File 'lib/aws-sdk-s3control/client.rb', line 7062

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

#put_bucket_versioning(params = {}) ⇒ Struct

<note markdown=“1”> This operation sets the versioning state for S3 on Outposts buckets only. To set the versioning state for an S3 bucket, see

PutBucketVersioning][1

in the *Amazon S3 API Reference*.

</note>

Sets the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.

You can set the versioning state to one of the following:

  • Enabled - Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

  • Suspended - Suspends versioning for the objects in the bucket. All objects added to the bucket receive the version ID ‘null`.

If you’ve never set versioning on your bucket, it has no versioning state. In that case, a [ GetBucketVersioning] request does not return a versioning state value.

When you enable S3 Versioning, for each object in your bucket, you have a current version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle rules to expire noncurrent versions after a specified time period. For more information, see [ Creating and managing a lifecycle configuration for your S3 on Outposts bucket] in the *Amazon S3 User Guide*.

If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. For more information, see [Versioning] in the *Amazon S3 User Guide*.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of ‘x-amz-outpost-id` to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of `s3-control`. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the `x-amz-outpost-id` derived by using the access point ARN, see the [Examples] section.

The following operations are related to ‘PutBucketVersioning` for S3 on Outposts.

  • GetBucketVersioning][2
  • PutBucketLifecycleConfiguration][6
  • GetBucketLifecycleConfiguration][7

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsLifecycleManaging.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html#API_control_PutBucketVersioning_Examples [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html

Examples:

Request syntax with placeholder values


resp = client.put_bucket_versioning({
  account_id: "AccountId",
  bucket: "BucketName", # required
  mfa: "MFA",
  versioning_configuration: { # required
    mfa_delete: "Enabled", # accepts Enabled, Disabled
    status: "Enabled", # accepts Enabled, Suspended
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 on Outposts bucket.

  • :bucket (required, String) —

    The S3 on Outposts bucket to set the versioning state for.

  • :mfa (String) —

    The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device.

  • :versioning_configuration (required, Types::VersioningConfiguration) —

    The root-level tag for the ‘VersioningConfiguration` parameters.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7162
7163
7164
7165
 
# File 'lib/aws-sdk-s3control/client.rb', line 7162

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

#put_job_tagging(params = {}) ⇒ Struct

Sets the supplied tag-set on an S3 Batch Operations job.

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using [GetJobTagging], modify that tag set, and use this operation to replace the tag set with the one you modified. For more information, see [Controlling access and labeling jobs using tags] in the *Amazon S3 User Guide*.

<note markdown=“1”> * If you send this request with an empty tag set, Amazon S3 deletes

the existing tag set on the Batch Operations job. If you use this
method, you are charged for a Tier 1 Request (PUT). For more
information, see [Amazon S3 pricing][3].

  • For deleting existing tags for your Batch Operations job, a

    DeleteJobTagging][4

    request is preferred because it achieves the

    same result without incurring charges.

  • A few things to consider about using tags:

    • Amazon S3 limits the maximum number of tags to 50 tags per job.

    • You can associate up to 50 tags with a job as long as they have unique tag keys.

    • A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.

    • The key and values are case sensitive.

    • For tagging-related restrictions related to characters and encodings, see [User-Defined Tag Restrictions] in the *Billing and Cost Management User Guide*.

</note>

Permissions

: To use the ‘PutJobTagging` operation, you must have permission to

perform the `s3:PutJobTagging` action.

Related actions include:

  • CreateJob][6
  • GetJobTagging][1
  • DeleteJobTagging][4

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags [3]: aws.amazon.com/s3/pricing/ [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html [5]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html

Examples:

Request syntax with placeholder values


resp = client.put_job_tagging({
  account_id: "AccountId",
  job_id: "JobId", # required
  tags: [ # required
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

  • :job_id (required, String) —

    The ID for the S3 Batch Operations job whose tags you want to replace.

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

    The set of tags to associate with the S3 Batch Operations job.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7257
7258
7259
7260
 
# File 'lib/aws-sdk-s3control/client.rb', line 7257

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

#put_multi_region_access_point_policy(params = {}) ⇒ Types::PutMultiRegionAccessPointPolicyResult

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see [Multi-Region Access Point restrictions and limitations] in the *Amazon S3 User Guide*.

The following actions are related to ‘PutMultiRegionAccessPointPolicy`:

  • GetMultiRegionAccessPointPolicy][2
  • GetMultiRegionAccessPointPolicyStatus][3

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html

Examples:

Request syntax with placeholder values


resp = client.put_multi_region_access_point_policy({
  account_id: "AccountId",
  client_token: "MultiRegionAccessPointClientToken", # required
  details: { # required
    name: "MultiRegionAccessPointName", # required
    policy: "Policy", # required
  },
})

Response structure


resp.request_token_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

  • :client_token (required, String) —

    An idempotency token used to identify the request and guarantee that requests are unique.

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

  • :details (required, Types::PutMultiRegionAccessPointPolicyInput) —

    A container element containing the details of the policy for the Multi-Region Access Point.

Returns:

See Also:



7327
7328
7329
7330
 
# File 'lib/aws-sdk-s3control/client.rb', line 7327

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

#put_public_access_block(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Creates or modifies the ‘PublicAccessBlock` configuration for an Amazon Web Services account. This operation may be restricted when the account is managed by organization-level Block Public Access policies. You might get an Access Denied (403) error when the account is managed by organization-level Block Public Access policies. Organization-level policies override account-level settings, preventing direct account-level modifications. For this operation, users must have the `s3:PutAccountPublicAccessBlock` permission. For more information, see [ Using Amazon S3 block public access].

Related actions include:

  • GetPublicAccessBlock][2
  • DeletePublicAccessBlock][3

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html

Examples:

Request syntax with placeholder values


resp = client.put_public_access_block({
  public_access_block_configuration: { # required
    block_public_acls: false,
    ignore_public_acls: false,
    block_public_policy: false,
    restrict_public_buckets: false,
  },
  account_id: "AccountId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :public_access_block_configuration (required, Types::PublicAccessBlockConfiguration) —

    The ‘PublicAccessBlock` configuration that you want to apply to the specified Amazon Web Services account.

  • :account_id (String) —

    The account ID for the Amazon Web Services account whose ‘PublicAccessBlock` configuration you want to set.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7384
7385
7386
7387
 
# File 'lib/aws-sdk-s3control/client.rb', line 7384

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

#put_storage_lens_configuration(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see [Working with Amazon S3 Storage Lens] in the *Amazon S3 User Guide*. For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary] in the *Amazon S3 User Guide*.

<note markdown=“1”> To use this action, you must have permission to perform the ‘s3:PutStorageLensConfiguration` action. For more information, see

Setting permissions to use Amazon S3 Storage Lens][3

in the *Amazon

S3 User Guide*.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html

Examples:

Request syntax with placeholder values


resp = client.put_storage_lens_configuration({
  config_id: "ConfigId", # required
  account_id: "AccountId",
  storage_lens_configuration: { # required
    id: "ConfigId", # required
    account_level: { # required
      activity_metrics: {
        is_enabled: false,
      },
      bucket_level: { # required
        activity_metrics: {
          is_enabled: false,
        },
        prefix_level: {
          storage_metrics: { # required
            is_enabled: false,
            selection_criteria: {
              delimiter: "StorageLensPrefixLevelDelimiter",
              max_depth: 1,
              min_storage_bytes_percentage: 1.0,
            },
          },
        },
        advanced_cost_optimization_metrics: {
          is_enabled: false,
        },
        advanced_data_protection_metrics: {
          is_enabled: false,
        },
        detailed_status_codes_metrics: {
          is_enabled: false,
        },
        advanced_performance_metrics: {
          is_enabled: false,
        },
      },
      advanced_cost_optimization_metrics: {
        is_enabled: false,
      },
      advanced_data_protection_metrics: {
        is_enabled: false,
      },
      detailed_status_codes_metrics: {
        is_enabled: false,
      },
      advanced_performance_metrics: {
        is_enabled: false,
      },
      storage_lens_group_level: {
        selection_criteria: {
          include: ["StorageLensGroupArn"],
          exclude: ["StorageLensGroupArn"],
        },
      },
    },
    include: {
      buckets: ["S3BucketArnString"],
      regions: ["S3AWSRegion"],
    },
    exclude: {
      buckets: ["S3BucketArnString"],
      regions: ["S3AWSRegion"],
    },
    data_export: {
      s3_bucket_destination: {
        format: "CSV", # required, accepts CSV, Parquet
        output_schema_version: "V_1", # required, accepts V_1
        account_id: "AccountId", # required
        arn: "S3BucketArnString", # required
        prefix: "Prefix",
        encryption: {
          sses3: {
          },
          ssekms: {
            key_id: "SSEKMSKeyId", # required
          },
        },
      },
      cloud_watch_metrics: {
        is_enabled: false, # required
      },
      storage_lens_table_destination: {
        is_enabled: false, # required
        encryption: {
          sses3: {
          },
          ssekms: {
            key_id: "SSEKMSKeyId", # required
          },
        },
      },
    },
    expanded_prefixes_data_export: {
      s3_bucket_destination: {
        format: "CSV", # required, accepts CSV, Parquet
        output_schema_version: "V_1", # required, accepts V_1
        account_id: "AccountId", # required
        arn: "S3BucketArnString", # required
        prefix: "Prefix",
        encryption: {
          sses3: {
          },
          ssekms: {
            key_id: "SSEKMSKeyId", # required
          },
        },
      },
      storage_lens_table_destination: {
        is_enabled: false, # required
        encryption: {
          sses3: {
          },
          ssekms: {
            key_id: "SSEKMSKeyId", # required
          },
        },
      },
    },
    is_enabled: false, # required
    aws_org: {
      arn: "AwsOrgArn", # required
    },
    storage_lens_arn: "StorageLensArn",
    prefix_delimiter: "StorageLensPrefixLevelDelimiter",
  },
  tags: [
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :config_id (required, String) —

    The ID of the S3 Storage Lens configuration.

  • :account_id (String) —

    The account ID of the requester.

  • :storage_lens_configuration (required, Types::StorageLensConfiguration) —

    The S3 Storage Lens configuration.

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

    The tag set of the S3 Storage Lens configuration.

    <note markdown=“1”> You can set up to a maximum of 50 tags.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7569
7570
7571
7572
 
# File 'lib/aws-sdk-s3control/client.rb', line 7569

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

#put_storage_lens_configuration_tagging(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see [Assessing your storage activity and usage with Amazon S3 Storage Lens ][1] in the *Amazon S3 User Guide*.

<note markdown=“1”> To use this action, you must have permission to perform the ‘s3:PutStorageLensConfigurationTagging` action. For more information, see [Setting permissions to use Amazon S3 Storage Lens] in the *Amazon S3 User Guide*.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html

Examples:

Request syntax with placeholder values


resp = client.put_storage_lens_configuration_tagging({
  config_id: "ConfigId", # required
  account_id: "AccountId",
  tags: [ # required
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :config_id (required, String) —

    The ID of the S3 Storage Lens configuration.

  • :account_id (String) —

    The account ID of the requester.

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

    The tag set of the S3 Storage Lens configuration.

    <note markdown=“1”> You can set up to a maximum of 50 tags.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7627
7628
7629
7630
 
# File 'lib/aws-sdk-s3control/client.rb', line 7627

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

#submit_multi_region_access_point_routes(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported by directory buckets.

</note>

Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the routing status for the specified Regions from active to passive, or from passive to active. A value of ‘0` indicates a passive status, which means that traffic won’t be routed to the specified Region. A value of ‘100` indicates an active status, which means that traffic will be routed to the specified Region. At least one Region must be active at all times.

When the routing configuration is changed, any in-progress operations (uploads, copies, deletes, and so on) to formerly active Regions will continue to run to their final completion state (success or failure). The routing configurations of any Regions that aren’t specified remain unchanged.

<note markdown=“1”> Updated routing configurations might not be immediately applied. It can take up to 2 minutes for your changes to take effect.

</note>

To submit routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:

  • ‘us-east-1`

  • ‘us-west-2`

  • ‘ap-southeast-2`

  • ‘ap-northeast-1`

  • ‘eu-west-1`

Examples:

Request syntax with placeholder values


resp = client.submit_multi_region_access_point_routes({
  account_id: "AccountId",
  mrap: "MultiRegionAccessPointId", # required
  route_updates: [ # required
    {
      bucket: "BucketName",
      region: "RegionName",
      traffic_dial_percentage: 1, # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

  • :mrap (required, String) —

    The Multi-Region Access Point ARN.

  • :route_updates (required, Array<Types::MultiRegionAccessPointRoute>) —

    The different routes that make up the new route configuration. Active routes return a value of ‘100`, and passive routes return a value of `0`.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7701
7702
7703
7704
 
# File 'lib/aws-sdk-s3control/client.rb', line 7701

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

#tag_resource(params = {}) ⇒ Struct

Creates a new user-defined tag or updates an existing tag. Each tag is a label consisting of a key and value that is applied to your resource. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 Amazon Web Services resource tags for each S3 resource.

<note markdown=“1”> This operation is only supported for the following Amazon S3 resource:

* [General purpose buckets][1]
  • Access Points for directory buckets][2
  • Access Points for general purpose buckets][3
  • Directory buckets][4
  • S3 Storage Lens groups][5

  • [S3 Access Grants instances, registered locations, or grants].

</note>

Permissions

: For general purpose buckets, access points for general purpose

buckets, Storage Lens groups, and S3 Access Grants, you must have
the `s3:TagResource` permission to use this operation.

Directory bucket permissions

: For directory buckets, you must have the ‘s3express:TagResource`

permission to use this operation. For more information about
directory buckets policies and permissions, see [Identity and Access
Management (IAM) for S3 Express One Zone][7] in the *Amazon S3 User
Guide*.

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is

`s3express-control.region.amazonaws.com`.

For information about S3 Tagging errors, see [List of Amazon S3 Tagging error codes].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-db-tagging.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-tagging.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html [6]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html [7]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-permissions.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  account_id: "AccountId",
  resource_arn: "S3ResourceArn", # required
  tags: [ # required
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID that created the S3 resource that you’re trying to add tags to or the requester’s account ID.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the S3 resource that you’re applying tags to. The tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.

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

    The Amazon Web Services resource tags that you want to add to the specified S3 resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7794
7795
7796
7797
 
# File 'lib/aws-sdk-s3control/client.rb', line 7794

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

#untag_resource(params = {}) ⇒ Struct

This operation removes the specified user-defined tags from an S3 resource. You can pass one or more tag keys.

<note markdown=“1”> This operation is only supported for the following Amazon S3 resources:

* [General purpose buckets][1]
  • Access Points for directory buckets][2
  • Access Points for general purpose buckets][3
  • Directory buckets][4
  • S3 Storage Lens groups][5

  • [S3 Access Grants instances, registered locations, and grants].

</note>

Permissions

: For general purpose buckets, access points for general purpose

buckets, Storage Lens groups, and S3 Access Grants, you must have
the `s3:UntagResource` permission to use this operation.

Directory bucket permissions

: For directory buckets, you must have the ‘s3express:UntagResource`

permission to use this operation. For more information about
directory buckets policies and permissions, see [Identity and Access
Management (IAM) for S3 Express One Zone][7] in the *Amazon S3 User
Guide*.

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is

`s3express-control.region.amazonaws.com`.

For information about S3 Tagging errors, see [List of Amazon S3 Tagging error codes].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-db-tagging.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-tagging.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html [6]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html [7]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-permissions.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  account_id: "AccountId",
  resource_arn: "S3ResourceArn", # required
  tag_keys: ["TagKeyString"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID that owns the resource that you’re trying to remove the tags from.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the S3 resource that you’re removing tags from. The tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.

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

    The array of tag key-value pairs that you’re trying to remove from of the S3 resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7880
7881
7882
7883
 
# File 'lib/aws-sdk-s3control/client.rb', line 7880

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

#update_access_grants_location(params = {}) ⇒ Types::UpdateAccessGrantsLocationResult

Updates the IAM role of a registered location in your S3 Access Grants instance.

Permissions

: You must have the ‘s3:UpdateAccessGrantsLocation` permission to use

this operation.

Additional Permissions

: You must also have the following permission: ‘iam:PassRole`

Examples:

Request syntax with placeholder values


resp = client.update_access_grants_location({
  account_id: "AccountId",
  access_grants_location_id: "AccessGrantsLocationId", # required
  iam_role_arn: "IAMRoleArn", # required
})

Response structure


resp.created_at #=> Time
resp.access_grants_location_id #=> String
resp.access_grants_location_arn #=> String
resp.location_scope #=> String
resp.iam_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • :access_grants_location_id (required, String) —

    The ID of the registered location that you are updating. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID ‘default` to the default location `s3://` and assigns an auto-generated ID to other locations that you register.

    The ID of the registered location to which you are granting access. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID ‘default` to the default location `s3://` and assigns an auto-generated ID to other locations that you register.

    If you are passing the ‘default` location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the `Subprefix` field.

  • :iam_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

Returns:

See Also:



7948
7949
7950
7951
 
# File 'lib/aws-sdk-s3control/client.rb', line 7948

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

#update_job_priority(params = {}) ⇒ Types::UpdateJobPriorityResult

Updates an existing S3 Batch Operations job’s priority. For more information, see [S3 Batch Operations] in the *Amazon S3 User Guide*.

Permissions

: To use the ‘UpdateJobPriority` operation, you must have permission

to perform the `s3:UpdateJobPriority` action.

Related actions include:

  • CreateJob][2
  • ListJobs][3
  • DescribeJob][4
  • UpdateJobStatus][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html

Examples:

Request syntax with placeholder values


resp = client.update_job_priority({
  account_id: "AccountId",
  job_id: "JobId", # required
  priority: 1, # required
})

Response structure


resp.job_id #=> String
resp.priority #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

  • :job_id (required, String) —

    The ID for the job whose priority you want to update.

  • :priority (required, Integer) —

    The priority you want to assign to this job.

Returns:

See Also:



8012
8013
8014
8015
 
# File 'lib/aws-sdk-s3control/client.rb', line 8012

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

#update_job_status(params = {}) ⇒ Types::UpdateJobStatusResult

Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see [S3 Batch Operations] in the *Amazon S3 User Guide*.

Permissions

: To use the ‘UpdateJobStatus` operation, you must have permission to

perform the `s3:UpdateJobStatus` action.

Related actions include:

  • CreateJob][2
  • ListJobs][3
  • DescribeJob][4
  • UpdateJobStatus][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html

Examples:

Request syntax with placeholder values


resp = client.update_job_status({
  account_id: "AccountId",
  job_id: "JobId", # required
  requested_job_status: "Cancelled", # required, accepts Cancelled, Ready
  status_update_reason: "JobStatusUpdateReason",
})

Response structure


resp.job_id #=> String
resp.status #=> String, one of "Active", "Cancelled", "Cancelling", "Complete", "Completing", "Failed", "Failing", "New", "Paused", "Pausing", "Preparing", "Ready", "Suspended"
resp.status_update_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    The Amazon Web Services account ID associated with the S3 Batch Operations job.

  • :job_id (required, String) —

    The ID of the job whose status you want to update.

  • :requested_job_status (required, String) —

    The status that you want to move the specified job to.

  • :status_update_reason (String) —

    A description of the reason why you want to change the specified job’s status. This field can be any string up to the maximum length.

Returns:

See Also:



8084
8085
8086
8087
 
# File 'lib/aws-sdk-s3control/client.rb', line 8084

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

#update_storage_lens_group(params = {}) ⇒ Struct

Updates the existing Storage Lens group.

To use this operation, you must have the permission to perform the ‘s3:UpdateStorageLensGroup` action. For more information about the required Storage Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups].

For information about Storage Lens groups errors, see [List of Amazon S3 Storage Lens error codes].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions [2]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList

Examples:

Request syntax with placeholder values


resp = client.update_storage_lens_group({
  name: "StorageLensGroupName", # required
  account_id: "AccountId",
  storage_lens_group: { # required
    name: "StorageLensGroupName", # required
    filter: { # required
      match_any_prefix: ["Prefix"],
      match_any_suffix: ["Suffix"],
      match_any_tag: [
        {
          key: "TagKeyString", # required
          value: "TagValueString", # required
        },
      ],
      match_object_age: {
        days_greater_than: 1,
        days_less_than: 1,
      },
      match_object_size: {
        bytes_greater_than: 1,
        bytes_less_than: 1,
      },
      and: {
        match_any_prefix: ["Prefix"],
        match_any_suffix: ["Suffix"],
        match_any_tag: [
          {
            key: "TagKeyString", # required
            value: "TagValueString", # required
          },
        ],
        match_object_age: {
          days_greater_than: 1,
          days_less_than: 1,
        },
        match_object_size: {
          bytes_greater_than: 1,
          bytes_less_than: 1,
        },
      },
      or: {
        match_any_prefix: ["Prefix"],
        match_any_suffix: ["Suffix"],
        match_any_tag: [
          {
            key: "TagKeyString", # required
            value: "TagValueString", # required
          },
        ],
        match_object_age: {
          days_greater_than: 1,
          days_less_than: 1,
        },
        match_object_size: {
          bytes_greater_than: 1,
          bytes_less_than: 1,
        },
      },
    },
    storage_lens_group_arn: "StorageLensGroupArn",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Storage Lens group that you want to update.

  • :account_id (String) —

    The Amazon Web Services account ID of the Storage Lens group owner.

  • :storage_lens_group (required, Types::StorageLensGroup) —

    The JSON file that contains the Storage Lens group configuration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8184
8185
8186
8187
 
# File 'lib/aws-sdk-s3control/client.rb', line 8184

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


8213
8214
8215
 
# File 'lib/aws-sdk-s3control/client.rb', line 8213

def waiter_names
  []
end