From 28b6202b58b838ac534c7d59c011e1ae21a1b4e2 Mon Sep 17 00:00:00 2001 From: davidlm Date: Sun, 26 Nov 2023 13:38:47 -0500 Subject: [PATCH 1/5] Add pagination config for GetChatControlsConfiguration in qbusiness --- .../2023-11-27/paginators-1.sdk-extras.json | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 botocore/data/qbusiness/2023-11-27/paginators-1.sdk-extras.json diff --git a/botocore/data/qbusiness/2023-11-27/paginators-1.sdk-extras.json b/botocore/data/qbusiness/2023-11-27/paginators-1.sdk-extras.json new file mode 100644 index 0000000000..11d3ddf34f --- /dev/null +++ b/botocore/data/qbusiness/2023-11-27/paginators-1.sdk-extras.json @@ -0,0 +1,13 @@ +{ + "version": 1.0, + "merge": { + "pagination": { + "GetChatControlsConfiguration": { + "non_aggregate_keys": [ + "responseScope", + "blockedPhrases" + ] + } + } + } +} \ No newline at end of file From 826b78c54dd87b9da368e9ab6017d8c4823b28c1 Mon Sep 17 00:00:00 2001 From: Nate Prewitt Date: Wed, 23 Aug 2023 11:07:14 -0600 Subject: [PATCH 2/5] Intial implementation for S3Express --- botocore/auth.py | 173 ++++++++++++++++ botocore/client.py | 32 ++- botocore/credentials.py | 22 ++- botocore/handlers.py | 10 +- botocore/signers.py | 33 +++- botocore/utils.py | 204 ++++++++++++++++++- tests/functional/test_s3express.py | 308 +++++++++++++++++++++++++++++ 7 files changed, 764 insertions(+), 18 deletions(-) create mode 100644 tests/functional/test_s3express.py diff --git a/botocore/auth.py b/botocore/auth.py index f9fac833fe..8389c1579c 100644 --- a/botocore/auth.py +++ b/botocore/auth.py @@ -529,6 +529,176 @@ def _normalize_url_path(self, path): return path +class S3ExpressAuth(S3SigV4Auth): + REQUIRES_IDENTITY_CACHE = True + + def __init__( + self, credentials, service_name, region_name, *, identity_cache + ): + super().__init__(credentials, service_name, region_name) + self._identity_cache = identity_cache + + def add_auth(self, request): + super().add_auth(request) + + def _modify_request_before_signing(self, request): + super()._modify_request_before_signing(request) + if 'x-amz-s3session-token' not in request.headers: + request.headers['x-amz-s3session-token'] = self.credentials.token + # S3Express does not support STS' X-Amz-Security-Token + if 'X-Amz-Security-Token' in request.headers: + del request.headers['X-Amz-Security-Token'] + + +class S3ExpressPostAuth(S3ExpressAuth): + REQUIRES_IDENTITY_CACHE = True + + def add_auth(self, request): + datetime_now = datetime.datetime.utcnow() + request.context['timestamp'] = datetime_now.strftime(SIGV4_TIMESTAMP) + + fields = {} + if request.context.get('s3-presign-post-fields', None) is not None: + fields = request.context['s3-presign-post-fields'] + + policy = {} + conditions = [] + if request.context.get('s3-presign-post-policy', None) is not None: + policy = request.context['s3-presign-post-policy'] + if policy.get('conditions', None) is not None: + conditions = policy['conditions'] + + policy['conditions'] = conditions + + fields['x-amz-algorithm'] = 'AWS4-HMAC-SHA256' + fields['x-amz-credential'] = self.scope(request) + fields['x-amz-date'] = request.context['timestamp'] + + conditions.append({'x-amz-algorithm': 'AWS4-HMAC-SHA256'}) + conditions.append({'x-amz-credential': self.scope(request)}) + conditions.append({'x-amz-date': request.context['timestamp']}) + + if self.credentials.token is not None: + fields['X-Amz-S3session-Token'] = self.credentials.token + conditions.append( + {'X-Amz-S3session-Token': self.credentials.token} + ) + + # Dump the base64 encoded policy into the fields dictionary. + fields['policy'] = base64.b64encode( + json.dumps(policy).encode('utf-8') + ).decode('utf-8') + + fields['x-amz-signature'] = self.signature(fields['policy'], request) + + request.context['s3-presign-post-fields'] = fields + request.context['s3-presign-post-policy'] = policy + + +class S3ExpressQueryAuth(S3ExpressAuth): + DEFAULT_EXPIRES = 300 + REQUIRES_IDENTITY_CACHE = True + + def __init__( + self, + credentials, + service_name, + region_name, + *, + identity_cache, + expires=DEFAULT_EXPIRES, + ): + super().__init__( + credentials, + service_name, + region_name, + identity_cache=identity_cache, + ) + self._expires = expires + + def _modify_request_before_signing(self, request): + # We automatically set this header, so if it's the auto-set value we + # want to get rid of it since it doesn't make sense for presigned urls. + content_type = request.headers.get('content-type') + blocklisted_content_type = ( + 'application/x-www-form-urlencoded; charset=utf-8' + ) + if content_type == blocklisted_content_type: + del request.headers['content-type'] + + # Note that we're not including X-Amz-Signature. + # From the docs: "The Canonical Query String must include all the query + # parameters from the preceding table except for X-Amz-Signature. + signed_headers = self.signed_headers(self.headers_to_sign(request)) + + auth_params = { + 'X-Amz-Algorithm': 'AWS4-HMAC-SHA256', + 'X-Amz-Credential': self.scope(request), + 'X-Amz-Date': request.context['timestamp'], + 'X-Amz-Expires': self._expires, + 'X-Amz-SignedHeaders': signed_headers, + } + if self.credentials.token is not None: + auth_params['X-Amz-S3session-Token'] = self.credentials.token + # Now parse the original query string to a dict, inject our new query + # params, and serialize back to a query string. + url_parts = urlsplit(request.url) + # parse_qs makes each value a list, but in our case we know we won't + # have repeated keys so we know we have single element lists which we + # can convert back to scalar values. + query_string_parts = parse_qs(url_parts.query, keep_blank_values=True) + query_dict = {k: v[0] for k, v in query_string_parts.items()} + + if request.params: + query_dict.update(request.params) + request.params = {} + # The spec is particular about this. It *has* to be: + # https://?& + # You can't mix the two types of params together, i.e just keep doing + # new_query_params.update(op_params) + # new_query_params.update(auth_params) + # percent_encode_sequence(new_query_params) + operation_params = '' + if request.data: + # We also need to move the body params into the query string. To + # do this, we first have to convert it to a dict. + query_dict.update(_get_body_as_dict(request)) + request.data = '' + if query_dict: + operation_params = percent_encode_sequence(query_dict) + '&' + new_query_string = ( + f"{operation_params}{percent_encode_sequence(auth_params)}" + ) + # url_parts is a tuple (and therefore immutable) so we need to create + # a new url_parts with the new query string. + # - + # scheme - 0 + # netloc - 1 + # path - 2 + # query - 3 <-- we're replacing this. + # fragment - 4 + p = url_parts + new_url_parts = (p[0], p[1], p[2], new_query_string, p[4]) + request.url = urlunsplit(new_url_parts) + + def _inject_signature_to_request(self, request, signature): + # Rather than calculating an "Authorization" header, for the query + # param quth, we just append an 'X-Amz-Signature' param to the end + # of the query string. + request.url += '&X-Amz-Signature=%s' % signature + + def _normalize_url_path(self, path): + # For S3, we do not normalize the path. + return path + + def payload(self, request): + # From the doc link above: + # "You don't include a payload hash in the Canonical Request, because + # when you create a presigned URL, you don't know anything about the + # payload. Instead, you use a constant string "UNSIGNED-PAYLOAD". + return UNSIGNED_PAYLOAD + + class SigV4QueryAuth(SigV4Auth): DEFAULT_EXPIRES = 3600 @@ -970,6 +1140,9 @@ def add_auth(self, request): 's3-query': HmacV1QueryAuth, 's3-presign-post': HmacV1PostAuth, 's3v4-presign-post': S3SigV4PostAuth, + 'v4-s3express': S3ExpressAuth, + 'v4-s3express-query': S3ExpressQueryAuth, + 'v4-s3express-presign-post': S3ExpressPostAuth, 'bearer': BearerAuth, } diff --git a/botocore/client.py b/botocore/client.py index 9a89877994..7bbde0b856 100644 --- a/botocore/client.py +++ b/botocore/client.py @@ -18,6 +18,7 @@ from botocore.awsrequest import prepare_request_dict from botocore.compress import maybe_compress_request from botocore.config import Config +from botocore.credentials import RefreshableCredentials from botocore.discovery import ( EndpointDiscoveryHandler, EndpointDiscoveryManager, @@ -45,6 +46,7 @@ CachedProperty, EventbridgeSignerSetter, S3ControlArnParamHandlerv2, + S3ExpressIdentityResolver, S3RegionRedirectorv2, ensure_boolean, get_service_module_name, @@ -179,6 +181,7 @@ def create_client( client_config=client_config, scoped_config=scoped_config, ) + self._register_s3express_events(client=service_client) self._register_s3_control_events(client=service_client) self._register_endpoint_discovery( service_client, endpoint_url, client_config @@ -371,6 +374,18 @@ def _register_eventbridge_events( endpoint_url=endpoint_url, ).register(client.meta.events) + def _register_s3express_events( + self, + client, + endpoint_bridge=None, + endpoint_url=None, + client_config=None, + scoped_config=None, + ): + if client.meta.service_model.service_name != 's3': + return + S3ExpressIdentityResolver(client, RefreshableCredentials).register() + def _register_s3_events( self, client, @@ -459,6 +474,9 @@ def _default_s3_presign_to_sigv2(self, signature_version, **kwargs): if signature_version.startswith('v4a'): return + if signature_version.startswith('v4-s3express'): + return f'{signature_version}' + for suffix in ['-query', '-presign-post']: if signature_version.endswith(suffix): return f's3{suffix}' @@ -930,9 +948,17 @@ def _make_api_call(self, operation_name, api_params): operation_model=operation_model, context=request_context, ) - endpoint_url, additional_headers = self._resolve_endpoint_ruleset( + ( + endpoint_url, + additional_headers, + properties, + ) = self._resolve_endpoint_ruleset( operation_model, api_params, request_context ) + if properties: + # Pass arbitrary endpoint info with the Request + # for use during construction. + request_context['endpoint_properties'] = properties request_dict = self._convert_to_request_dict( api_params=api_params, operation_model=operation_model, @@ -1075,6 +1101,7 @@ def _resolve_endpoint_ruleset( if self._ruleset_resolver is None: endpoint_url = self.meta.endpoint_url additional_headers = {} + endpoint_properties = {} else: endpoint_info = self._ruleset_resolver.construct_endpoint( operation_model=operation_model, @@ -1083,6 +1110,7 @@ def _resolve_endpoint_ruleset( ) endpoint_url = endpoint_info.url additional_headers = endpoint_info.headers + endpoint_properties = endpoint_info.properties # If authSchemes is present, overwrite default auth type and # signing context derived from service model. auth_schemes = endpoint_info.properties.get('authSchemes') @@ -1099,7 +1127,7 @@ def _resolve_endpoint_ruleset( else: request_context['signing'] = signing_context - return endpoint_url, additional_headers + return endpoint_url, additional_headers, endpoint_properties def get_paginator(self, operation_name): """Create a paginator for an operation. diff --git a/botocore/credentials.py b/botocore/credentials.py index e57dd70d51..42707b0124 100644 --- a/botocore/credentials.py +++ b/botocore/credentials.py @@ -370,6 +370,8 @@ def __init__( refresh_using, method, time_fetcher=_local_now, + advisory_timeout=None, + mandatory_timeout=None, ): self._refresh_using = refresh_using self._access_key = access_key @@ -383,13 +385,30 @@ def __init__( access_key, secret_key, token ) self._normalize() + if advisory_timeout is not None: + self._advisory_refresh_timeout = advisory_timeout + if mandatory_timeout is not None: + self._mandatory_refresh_timeout = mandatory_timeout def _normalize(self): self._access_key = botocore.compat.ensure_unicode(self._access_key) self._secret_key = botocore.compat.ensure_unicode(self._secret_key) @classmethod - def create_from_metadata(cls, metadata, refresh_using, method): + def create_from_metadata( + cls, + metadata, + refresh_using, + method, + advisory_timeout=None, + mandatory_timeout=None, + ): + kwargs = {} + if advisory_timeout is not None: + kwargs['advisory_timeout'] = advisory_timeout + if mandatory_timeout is not None: + kwargs['mandatory_timeout'] = mandatory_timeout + instance = cls( access_key=metadata['access_key'], secret_key=metadata['secret_key'], @@ -397,6 +416,7 @@ def create_from_metadata(cls, metadata, refresh_using, method): expiry_time=cls._expiry_datetime(metadata['expiry_time']), method=method, refresh_using=refresh_using, + **kwargs, ) return instance diff --git a/botocore/handlers.py b/botocore/handlers.py index 36828603ca..aa0ae98c0e 100644 --- a/botocore/handlers.py +++ b/botocore/handlers.py @@ -61,6 +61,7 @@ from botocore.utils import ( SAFE_CHARS, ArnParser, + conditionally_calculate_checksum, conditionally_calculate_md5, percent_encode, switch_host_with_param, @@ -97,7 +98,7 @@ VALID_S3_ARN = re.compile('|'.join([_ACCESSPOINT_ARN, _OUTPOST_ARN])) # signing names used for the services s3 and s3-control, for example in # botocore/data/s3/2006-03-01/endpoints-rule-set-1.json -S3_SIGNING_NAMES = ('s3', 's3-outposts', 's3-object-lambda') +S3_SIGNING_NAMES = ('s3', 's3-outposts', 's3-object-lambda', 's3express') VERSION_ID_SUFFIX = re.compile(r'\?versionId=[^\s]+$') @@ -203,6 +204,9 @@ def set_operation_specific_signer(context, signing_name, **kwargs): return 'bearer' if auth_type.startswith('v4'): + if auth_type == 'v4-s3express': + return auth_type + if auth_type == 'v4a': # If sigv4a is chosen, we must add additional signing config for # global signature. @@ -1135,6 +1139,7 @@ def customize_endpoint_resolver_builtins( and not path_style_required and not path_style_requested and not bucket_is_arn + and not utils.is_s3express_bucket(bucket_name) ): builtins[EndpointResolverBuiltins.AWS_REGION] = 'aws-global' builtins[EndpointResolverBuiltins.AWS_S3_USE_GLOBAL_ENDPOINT] = True @@ -1207,9 +1212,10 @@ def remove_content_type_header_for_presigning(request, **kwargs): ('before-call.s3', add_expect_header), ('before-call.glacier', add_glacier_version), ('before-call.apigateway', add_accept_header), - ('before-call.s3.PutObject', conditionally_calculate_md5), + ('before-call.s3.PutObject', conditionally_calculate_checksum), ('before-call.s3.UploadPart', conditionally_calculate_md5), ('before-call.s3.DeleteObjects', escape_xml_payload), + ('before-call.s3.DeleteObjects', conditionally_calculate_checksum), ('before-call.s3.PutBucketLifecycleConfiguration', escape_xml_payload), ('before-call.glacier.UploadArchive', add_glacier_checksums), ('before-call.glacier.UploadMultipartPart', add_glacier_checksums), diff --git a/botocore/signers.py b/botocore/signers.py index 0acbf68463..a057b0acd7 100644 --- a/botocore/signers.py +++ b/botocore/signers.py @@ -176,6 +176,12 @@ def sign( kwargs['region_name'] = signing_context['region'] if signing_context.get('signing_name'): kwargs['signing_name'] = signing_context['signing_name'] + if signing_context.get('identity_cache') is not None: + self._resolve_identity_cache( + kwargs, + signing_context['identity_cache'], + signing_context['cache_key'], + ) try: auth = self.get_auth_instance(**kwargs) except UnknownSignatureVersionError as e: @@ -188,6 +194,10 @@ def sign( auth.add_auth(request) + def _resolve_identity_cache(self, kwargs, cache, cache_key): + kwargs['identity_cache'] = cache + kwargs['cache_key'] = cache_key + def _choose_signer(self, operation_name, signing_type, context): """ Allow setting the signature version via the choose-signer event. @@ -275,13 +285,20 @@ def get_auth_instance( auth = cls(frozen_token) return auth + credentials = self._credentials + if getattr(cls, "REQUIRES_IDENTITY_CACHE", None) is True: + cache = kwargs["identity_cache"] + key = kwargs["cache_key"] + credentials = cache.get_credentials(key) + del kwargs["cache_key"] + # If there's no credentials provided (i.e credentials is None), # then we'll pass a value of "None" over to the auth classes, # which already handle the cases where no credentials have # been provided. frozen_credentials = None - if self._credentials is not None: - frozen_credentials = self._credentials.get_frozen_credentials() + if credentials is not None: + frozen_credentials = credentials.get_frozen_credentials() kwargs['credentials'] = frozen_credentials if cls.REQUIRES_REGION: if self._region_name is None: @@ -662,7 +679,11 @@ def generate_presigned_url( context=context, ) bucket_is_arn = ArnParser.is_arn(params.get('Bucket', '')) - endpoint_url, additional_headers = self._resolve_endpoint_ruleset( + ( + endpoint_url, + additional_headers, + properties, + ) = self._resolve_endpoint_ruleset( operation_model, params, context, @@ -789,7 +810,11 @@ def generate_presigned_post( context=context, ) bucket_is_arn = ArnParser.is_arn(params.get('Bucket', '')) - endpoint_url, additional_headers = self._resolve_endpoint_ruleset( + ( + endpoint_url, + additional_headers, + properties, + ) = self._resolve_endpoint_ruleset( operation_model, params, context, diff --git a/botocore/utils.py b/botocore/utils.py index 2cff8adc20..1fa5a8fbb6 100644 --- a/botocore/utils.py +++ b/botocore/utils.py @@ -25,6 +25,7 @@ import time import warnings import weakref +from datetime import datetime as _DatetimeClass from ipaddress import ip_address from pathlib import Path from urllib.request import getproxies, proxy_bypass @@ -1028,7 +1029,7 @@ def parse_to_aware_datetime(value): # converting the provided value to a string timestamp suitable to be # serialized to an http request. It can handle: # 1) A datetime.datetime object. - if isinstance(value, datetime.datetime): + if isinstance(value, _DatetimeClass): datetime_obj = value else: # 2) A string object that's formatted as a timestamp. @@ -1585,6 +1586,136 @@ def hyphenize_service_id(service_id): return service_id.replace(' ', '-').lower() +class IdentityCache: + """Base IdentityCache implementation for storing and retrieving + highly accessed credentials. + + This class is not intended to be instantiated in user code. + """ + + METHOD = "base_identity_cache" + + def __init__(self, client, credential_cls): + self._client = client + self._credential_cls = credential_cls + + def get_credentials(self, **kwargs): + callback = self.build_refresh_callback(**kwargs) + metadata = callback() + credential_entry = self._credential_cls.create_from_metadata( + metadata=metadata, + refresh_using=callback, + method=self.METHOD, + advisory_timeout=45, + mandatory_timeout=10, + ) + return credential_entry + + def build_refresh_callback(**kwargs): + """Callback to be implemented by subclasses. + + Returns a set of metadata to be converted into a new + credential instance. + """ + raise NotImplementedError() + + +class S3ExpressIdentityCache(IdentityCache): + """S3Express IdentityCache for retrieving and storing + credentials from CreateSession calls. + + This class is not intended to be instantiated in user code. + """ + + METHOD = "s3express" + + def __init__(self, client, credential_cls): + self._client = client + self._credential_cls = credential_cls + + @functools.lru_cache(maxsize=100) + def get_credentials(self, bucket): + return super().get_credentials(bucket=bucket) + + def build_refresh_callback(self, bucket): + def refresher(): + response = self._client.create_session(Bucket=bucket) + creds = response['Credentials'] + expiration = self._serialize_if_needed( + creds['Expiration'], iso=True + ) + return { + "access_key": creds['AccessKeyId'], + "secret_key": creds['SecretAccessKey'], + "token": creds['SessionToken'], + "expiry_time": expiration, + } + + return refresher + + def _serialize_if_needed(self, value, iso=False): + if isinstance(value, _DatetimeClass): + if iso: + return value.isoformat() + return value.strftime('%Y-%m-%dT%H:%M:%S%Z') + return value + + +class S3ExpressIdentityResolver: + def __init__(self, client, credential_cls, cache=None): + self._client = weakref.proxy(client) + + if cache is None: + cache = S3ExpressIdentityCache(self._client, credential_cls) + self._cache = cache + + def register(self, event_emitter=None): + logger.debug('Registering S3Express Identity Resolver') + emitter = event_emitter or self._client.meta.events + emitter.register( + 'before-parameter-build.s3', self.inject_signing_cache_key + ) + emitter.register('before-call.s3', self.apply_signing_cache_key) + emitter.register('before-sign.s3', self.resolve_s3express_identity) + + def inject_signing_cache_key(self, params, context, **kwargs): + if 'Bucket' in params: + context['S3Express'] = {'bucket_name': params['Bucket']} + + def apply_signing_cache_key(self, params, context, **kwargs): + endpoint_properties = context.get('endpoint_properties', {}) + backend = endpoint_properties.get('backend', None) + + # Add cache key if Bucket supplied for s3express request + bucket_name = context.get('S3Express', {}).get('bucket_name') + if backend == 'S3Express' and bucket_name is not None: + context.setdefault('signing', {}) + context['signing']['cache_key'] = bucket_name + + def resolve_s3express_identity( + self, + request, + signing_name, + region_name, + signature_version, + request_signer, + operation_name, + **kwargs, + ): + signing_context = request.context.get('signing', {}) + signing_name = signing_context.get('signing_name') + if signing_name == 's3express' and signature_version.startswith( + 'v4-s3express' + ): + signing_context['identity_cache'] = self._cache + if 'cache_key' not in signing_context: + signing_context['cache_key'] = ( + request.context.get('s3_redirect', {}) + .get('params', {}) + .get('Bucket') + ) + + class S3RegionRedirectorv2: """Updated version of S3RegionRedirector for use when EndpointRulesetResolver is in use for endpoint resolution. @@ -3133,21 +3264,70 @@ def _calculate_md5_from_file(fileobj): return md5.digest() +def _is_s3express_request(params): + endpoint_properties = params.get('context', {}).get( + 'endpoint_properties', {} + ) + return endpoint_properties.get('backend') == 'S3Express' + + +def _has_checksum_header(params): + headers = params['headers'] + # If a user provided Content-MD5 is present, + # don't try to compute a new one. + if 'Content-MD5' in headers: + return True + + # If a header matching the x-amz-checksum-* pattern is present, we + # assume a checksum has already been provided and an md5 is not needed + for header in headers: + if CHECKSUM_HEADER_PATTERN.match(header): + return True + + return False + + +def conditionally_calculate_checksum(params, **kwargs): + if not _has_checksum_header(params): + conditionally_calculate_md5(params, **kwargs) + conditionally_enable_crc32(params, **kwargs) + + +def conditionally_enable_crc32(params, **kwargs): + checksum_context = params.get('context', {}).get('checksum', {}) + checksum_algorithm = checksum_context.get('request_algorithm') + if ( + _is_s3express_request(params) + and params['body'] is not None + and checksum_algorithm in (None, "conditional-md5") + ): + params['context']['checksum'] = { + 'request_algorithm': { + 'algorithm': 'crc32', + 'in': 'header', + 'name': 'x-amz-checksum-crc32', + } + } + + def conditionally_calculate_md5(params, **kwargs): """Only add a Content-MD5 if the system supports it.""" - headers = params['headers'] body = params['body'] checksum_context = params.get('context', {}).get('checksum', {}) checksum_algorithm = checksum_context.get('request_algorithm') if checksum_algorithm and checksum_algorithm != 'conditional-md5': # Skip for requests that will have a flexible checksum applied return - # If a header matching the x-amz-checksum-* pattern is present, we - # assume a checksum has already been provided and an md5 is not needed - for header in headers: - if CHECKSUM_HEADER_PATTERN.match(header): - return - if MD5_AVAILABLE and body is not None and 'Content-MD5' not in headers: + + if _has_checksum_header(params): + # Don't add a new header if one is already available. + return + + if _is_s3express_request(params): + # S3Express doesn't support MD5 + return + + if MD5_AVAILABLE and body is not None: md5_digest = calculate_md5(body, **kwargs) params['headers']['Content-MD5'] = md5_digest @@ -3373,13 +3553,19 @@ def _convert_cache_key(self, cache_key): return full_path def _serialize_if_needed(self, value, iso=False): - if isinstance(value, datetime.datetime): + if isinstance(value, _DatetimeClass): if iso: return value.isoformat() return value.strftime('%Y-%m-%dT%H:%M:%S%Z') return value +def is_s3express_bucket(bucket): + if bucket is None: + return False + return bucket.endswith('--x-s3') + + # This parameter is not part of the public interface and is subject to abrupt # breaking changes or removal without prior announcement. # Mapping of services that have been renamed for backwards compatibility reasons. diff --git a/tests/functional/test_s3express.py b/tests/functional/test_s3express.py new file mode 100644 index 0000000000..390721ee12 --- /dev/null +++ b/tests/functional/test_s3express.py @@ -0,0 +1,308 @@ +# Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"). You +# may not use this file except in compliance with the License. A copy of +# the License is located at +# +# http://aws.amazon.com/apache2.0/ +# +# or in the "license" file accompanying this file. This file is +# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF +# ANY KIND, either express or implied. See the License for the specific +# language governing permissions and limitations under the License. +import datetime + +import pytest +from dateutil.tz import tzutc + +import botocore.session +from botocore.auth import S3ExpressAuth +from botocore.awsrequest import AWSRequest +from botocore.credentials import Credentials, RefreshableCredentials +from botocore.utils import S3ExpressIdentityCache +from tests import ClientHTTPStubber, mock + +ACCESS_KEY = "AKIDEXAMPLE" +SECRET_KEY = "wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY" +TOKEN = "TOKEN" + +EXPRESS_ACCESS_KEY = "EXPRESS_AKIDEXAMPLE" +EXPRESS_SECRET_KEY = "EXPRESS_53cr37" +EXPRESS_TOKEN = "EXPRESS_TOKEN" + +CREDENTIALS = Credentials(ACCESS_KEY, SECRET_KEY, TOKEN) +ENDPOINT = "https://s3.us-west-2.amazonaws.com" + +S3EXPRESS_BUCKET = "mytestbucket--usw2-az5--x-s3" + + +DATE = datetime.datetime(2023, 11, 26, 0, 0, 0, tzinfo=tzutc()) + + +CREATE_SESSION_RESPONSE = ( + b"\n" + b"" + b"EXPRESS_TOKEN" + b"EXPRESS_53cr37" + b"EXPRESS_AKIDEXAMPLE" + b"2023-11-28T01:46:39Z" + b"" +) + + +@pytest.fixture +def default_s3_client(): + session = botocore.session.Session() + return session.create_client( + 's3', + 'us-west-2', + aws_access_key_id=ACCESS_KEY, + aws_secret_access_key=SECRET_KEY, + aws_session_token=TOKEN, + ) + + +@pytest.fixture +def mock_datetime(): + with mock.patch('datetime.datetime', spec=True) as mock_datetime: + yield mock_datetime + + +def _assert_expected_create_session_call(request, bucket): + assert bucket in request.url + assert request.url.endswith('?session') + assert request.method == "GET" + + +class TestS3ExpressAuth: + def _assert_has_expected_headers(self, request, header_list=None): + if header_list is None: + header_list = ["Authorization", "X-Amz-S3Session-Token"] + + for header in header_list: + assert header in request.headers + + def test_s3express_auth_requires_instance_cache(self): + assert hasattr(S3ExpressAuth, "REQUIRES_IDENTITY_CACHE") + assert S3ExpressAuth.REQUIRES_IDENTITY_CACHE is True + + def test_s3_express_auth_headers(self): + request = AWSRequest( + method='GET', + url=ENDPOINT, + ) + auth_instance = S3ExpressAuth( + CREDENTIALS, "s3", "us-west-2", identity_cache={} + ) + + # Confirm there is no existing auth info on request + assert 'Authorization' not in request.headers + auth_instance.add_auth(request) + self._assert_has_expected_headers(request) + + # Confirm we're not including the unsupported X-Amz-Security-Token + # header for S3Express. + assert 'X-Amz-Security-Token' not in request.headers + + +class TestS3ExpressIdentityCache: + def test_default_s3_express_cache(self, default_s3_client, mock_datetime): + mock_datetime.now.return_value = DATE + mock_datetime.utcnow.return_value = DATE + + identity_cache = S3ExpressIdentityCache( + default_s3_client, + RefreshableCredentials, + ) + with ClientHTTPStubber(default_s3_client) as stubber: + stubber.add_response(body=CREATE_SESSION_RESPONSE) + credentials = identity_cache.get_credentials('my_bucket') + + assert credentials.access_key == EXPRESS_ACCESS_KEY + assert credentials.secret_key == EXPRESS_SECRET_KEY + assert credentials.token == EXPRESS_TOKEN + + def test_s3_express_cache_one_network_call( + self, default_s3_client, mock_datetime + ): + mock_datetime.now.return_value = DATE + mock_datetime.utcnow.return_value = DATE + bucket = 'my_bucket' + + identity_cache = S3ExpressIdentityCache( + default_s3_client, + RefreshableCredentials, + ) + with ClientHTTPStubber(default_s3_client) as stubber: + # Only set one response + stubber.add_response(body=CREATE_SESSION_RESPONSE) + + first_creds = identity_cache.get_credentials(bucket) + second_creds = identity_cache.get_credentials(bucket) + + # Confirm we got back the same credentials + assert first_creds == second_creds + + # Confirm we didn't hit the API twice + assert len(stubber.requests) == 1 + _assert_expected_create_session_call(stubber.requests[0], bucket) + + def test_s3_express_cache_multiple_buckets( + self, default_s3_client, mock_datetime + ): + mock_datetime.now.return_value = DATE + mock_datetime.utcnow.return_value = DATE + bucket = 'my_bucket' + other_bucket = 'other_bucket' + + identity_cache = S3ExpressIdentityCache( + default_s3_client, + RefreshableCredentials, + ) + with ClientHTTPStubber(default_s3_client) as stubber: + stubber.add_response(body=CREATE_SESSION_RESPONSE) + stubber.add_response(body=CREATE_SESSION_RESPONSE) + + identity_cache.get_credentials(bucket) + identity_cache.get_credentials(other_bucket) + + # Confirm we hit the API for each bucket + assert len(stubber.requests) == 2 + _assert_expected_create_session_call(stubber.requests[0], bucket) + _assert_expected_create_session_call( + stubber.requests[1], other_bucket + ) + + +class TestS3ExpressRequests: + def _assert_standard_sigv4_signature(self, headers): + sigv4_auth_preamble = ( + b'AWS4-HMAC-SHA256 Credential=' + b'AKIDEXAMPLE/20231126/us-west-2/s3express/aws4_request' + ) + assert 'Authorization' in headers + assert headers['Authorization'].startswith(sigv4_auth_preamble) + + def _assert_s3express_credentials(self, headers): + s3express_auth_preamble = ( + b'AWS4-HMAC-SHA256 Credential=' + b'EXPRESS_AKIDEXAMPLE/20231126/us-west-2/s3express/aws4_request' + ) + assert 'Authorization' in headers + assert 'x-amz-s3session-token' in headers + assert headers['Authorization'].startswith(s3express_auth_preamble) + assert headers['x-amz-s3session-token'] == b'EXPRESS_TOKEN' + + def _assert_checksum_algorithm_added(self, algorithm, headers): + algorithm_header_name = f"x-amz-checksum-{algorithm}" + assert algorithm_header_name in headers + + def _call_get_object(self, client): + return client.get_object( + Bucket=S3EXPRESS_BUCKET, + Key='my-test-object', + ) + + def test_create_bucket(self, default_s3_client, mock_datetime): + mock_datetime.utcnow.return_value = DATE + + with ClientHTTPStubber(default_s3_client) as stubber: + stubber.add_response() + + default_s3_client.create_bucket( + Bucket=S3EXPRESS_BUCKET, + CreateBucketConfiguration={ + 'Location': { + 'Name': 'usw2-az5', + 'Type': 'AvailabilityZone', + }, + 'Bucket': { + "DataRedundancy": "SingleAvailabilityZone", + "Type": "Directory", + }, + }, + ) + + # Confirm we don't call CreateSession for create_bucket + assert len(stubber.requests) == 1 + self._assert_standard_sigv4_signature(stubber.requests[0].headers) + + def test_get_object(self, default_s3_client, mock_datetime): + mock_datetime.utcnow.return_value = DATE + mock_datetime.now.return_value = DATE + + with ClientHTTPStubber(default_s3_client) as stubber: + stubber.add_response(body=CREATE_SESSION_RESPONSE) + stubber.add_response() + + self._call_get_object(default_s3_client) + + # Confirm we called CreateSession for create_bucket + assert len(stubber.requests) == 2 + _assert_expected_create_session_call( + stubber.requests[0], S3EXPRESS_BUCKET + ) + self._assert_standard_sigv4_signature(stubber.requests[0].headers) + + # Confirm actual PutObject request was signed with Session credentials + self._assert_s3express_credentials(stubber.requests[1].headers) + + def test_cache_with_multiple_requests( + self, default_s3_client, mock_datetime + ): + mock_datetime.utcnow.return_value = DATE + mock_datetime.now.return_value = DATE + + with ClientHTTPStubber(default_s3_client) as stubber: + stubber.add_response(body=CREATE_SESSION_RESPONSE) + stubber.add_response() + stubber.add_response() + + self._call_get_object(default_s3_client) + self._call_get_object(default_s3_client) + + # Confirm we called CreateSession for create_bucket once + assert len(stubber.requests) == 3 + _assert_expected_create_session_call( + stubber.requests[0], S3EXPRESS_BUCKET + ) + self._assert_standard_sigv4_signature(stubber.requests[0].headers) + + # Confirm we signed both called with S3Express credentials + self._assert_s3express_credentials(stubber.requests[1].headers) + self._assert_s3express_credentials(stubber.requests[2].headers) + + def test_delete_objects_injects_correct_checksum( + self, default_s3_client, mock_datetime + ): + mock_datetime.utcnow.return_value = DATE + mock_datetime.now.return_value = DATE + + with ClientHTTPStubber(default_s3_client) as stubber: + stubber.add_response(body=CREATE_SESSION_RESPONSE) + stubber.add_response() + + default_s3_client.delete_objects( + Bucket=S3EXPRESS_BUCKET, + Delete={ + "Objects": [ + { + "Key": "my-obj", + "VersionId": "1", + } + ] + }, + ) + + # Confirm we called CreateSession for create_bucket + assert len(stubber.requests) == 2 + _assert_expected_create_session_call( + stubber.requests[0], S3EXPRESS_BUCKET + ) + self._assert_standard_sigv4_signature(stubber.requests[0].headers) + + # Confirm we signed both called with S3Express credentials + self._assert_s3express_credentials(stubber.requests[1].headers) + self._assert_checksum_algorithm_added( + 'crc32', stubber.requests[1].headers + ) From c5ddcdbe0d53d1a7027ddfa94de40ae7646bec7e Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Tue, 28 Nov 2023 18:59:47 +0000 Subject: [PATCH 3/5] Update to latest models --- .../api-change-accessanalyzer-49701.json | 5 + .../api-change-bedrock-34731.json | 5 + .../api-change-bedrockagent-69815.json | 5 + .../api-change-bedrockagentruntime-92513.json | 5 + .../api-change-bedrockruntime-29758.json | 5 + .../api-change-connect-51996.json | 5 + .../api-change-customerprofiles-94400.json | 5 + .../api-change-endpointrules-96440.json | 5 + .../api-change-qbusiness-11571.json | 5 + .../api-change-qconnect-80765.json | 5 + .../next-release/api-change-s3-30237.json | 5 + .../api-change-s3control-97162.json | 5 + .../accessanalyzer/2019-11-01/service-2.json | 20 +- .../2023-07-26/endpoint-rule-set-1.json | 350 + .../2023-07-26/paginators-1.json | 9 + .../2023-07-26/service-2.json | 1081 +++ .../2023-06-05/endpoint-rule-set-1.json | 350 + .../2023-06-05/paginators-1.json | 52 + .../bedrock-agent/2023-06-05/service-2.json | 3358 +++++++++ .../2023-09-30/endpoint-rule-set-1.json | 64 +- .../bedrock-runtime/2023-09-30/service-2.json | 40 +- .../bedrock-runtime/2023-09-30/waiters-2.json | 5 + .../2023-04-20/endpoint-rule-set-1.json | 64 +- .../data/bedrock/2023-04-20/service-2.json | 88 +- .../data/connect/2017-08-08/paginators-1.json | 6 + .../data/connect/2017-08-08/service-2.json | 1806 ++++- .../2020-08-15/endpoint-rule-set-1.json | 40 +- .../2020-08-15/service-2.json | 74 + .../2023-11-27/endpoint-rule-set-1.json | 247 + .../qbusiness/2023-11-27/paginators-1.json | 76 + .../data/qbusiness/2023-11-27/service-2.json | 5999 +++++++++++++++++ .../2020-10-19/endpoint-rule-set-1.json | 350 + .../qconnect/2020-10-19/paginators-1.json | 64 + .../data/qconnect/2020-10-19/service-2.json | 4399 ++++++++++++ .../s3/2006-03-01/endpoint-rule-set-1.json | 948 +++ botocore/data/s3/2006-03-01/paginators-1.json | 6 + botocore/data/s3/2006-03-01/service-2.json | 1594 +++-- .../data/s3control/2018-08-20/service-2.json | 181 +- .../endpoint-tests-1.json | 314 + .../bedrock-agent/endpoint-tests-1.json | 314 + .../qbusiness/endpoint-tests-1.json | 119 + .../qconnect/endpoint-tests-1.json | 314 + .../endpoint-rules/s3/endpoint-tests-1.json | 759 +++ 43 files changed, 22211 insertions(+), 940 deletions(-) create mode 100644 .changes/next-release/api-change-accessanalyzer-49701.json create mode 100644 .changes/next-release/api-change-bedrock-34731.json create mode 100644 .changes/next-release/api-change-bedrockagent-69815.json create mode 100644 .changes/next-release/api-change-bedrockagentruntime-92513.json create mode 100644 .changes/next-release/api-change-bedrockruntime-29758.json create mode 100644 .changes/next-release/api-change-connect-51996.json create mode 100644 .changes/next-release/api-change-customerprofiles-94400.json create mode 100644 .changes/next-release/api-change-endpointrules-96440.json create mode 100644 .changes/next-release/api-change-qbusiness-11571.json create mode 100644 .changes/next-release/api-change-qconnect-80765.json create mode 100644 .changes/next-release/api-change-s3-30237.json create mode 100644 .changes/next-release/api-change-s3control-97162.json create mode 100644 botocore/data/bedrock-agent-runtime/2023-07-26/endpoint-rule-set-1.json create mode 100644 botocore/data/bedrock-agent-runtime/2023-07-26/paginators-1.json create mode 100644 botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json create mode 100644 botocore/data/bedrock-agent/2023-06-05/endpoint-rule-set-1.json create mode 100644 botocore/data/bedrock-agent/2023-06-05/paginators-1.json create mode 100644 botocore/data/bedrock-agent/2023-06-05/service-2.json create mode 100644 botocore/data/bedrock-runtime/2023-09-30/waiters-2.json create mode 100644 botocore/data/qbusiness/2023-11-27/endpoint-rule-set-1.json create mode 100644 botocore/data/qbusiness/2023-11-27/paginators-1.json create mode 100644 botocore/data/qbusiness/2023-11-27/service-2.json create mode 100644 botocore/data/qconnect/2020-10-19/endpoint-rule-set-1.json create mode 100644 botocore/data/qconnect/2020-10-19/paginators-1.json create mode 100644 botocore/data/qconnect/2020-10-19/service-2.json create mode 100644 tests/functional/endpoint-rules/bedrock-agent-runtime/endpoint-tests-1.json create mode 100644 tests/functional/endpoint-rules/bedrock-agent/endpoint-tests-1.json create mode 100644 tests/functional/endpoint-rules/qbusiness/endpoint-tests-1.json create mode 100644 tests/functional/endpoint-rules/qconnect/endpoint-tests-1.json diff --git a/.changes/next-release/api-change-accessanalyzer-49701.json b/.changes/next-release/api-change-accessanalyzer-49701.json new file mode 100644 index 0000000000..d5b3b95a4e --- /dev/null +++ b/.changes/next-release/api-change-accessanalyzer-49701.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``accessanalyzer``", + "description": "This release adds support for external access findings for S3 directory buckets to help you easily identify cross-account access. Updated service API, documentation, and paginators." +} diff --git a/.changes/next-release/api-change-bedrock-34731.json b/.changes/next-release/api-change-bedrock-34731.json new file mode 100644 index 0000000000..f5ecb3fd31 --- /dev/null +++ b/.changes/next-release/api-change-bedrock-34731.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``bedrock``", + "description": "This release adds support for customization types, model life cycle status and minor versions/aliases for model identifiers." +} diff --git a/.changes/next-release/api-change-bedrockagent-69815.json b/.changes/next-release/api-change-bedrockagent-69815.json new file mode 100644 index 0000000000..a4e5131f3d --- /dev/null +++ b/.changes/next-release/api-change-bedrockagent-69815.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``bedrock-agent``", + "description": "This release introduces Agents for Amazon Bedrock" +} diff --git a/.changes/next-release/api-change-bedrockagentruntime-92513.json b/.changes/next-release/api-change-bedrockagentruntime-92513.json new file mode 100644 index 0000000000..a28079c619 --- /dev/null +++ b/.changes/next-release/api-change-bedrockagentruntime-92513.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``bedrock-agent-runtime``", + "description": "This release introduces Agents for Amazon Bedrock Runtime" +} diff --git a/.changes/next-release/api-change-bedrockruntime-29758.json b/.changes/next-release/api-change-bedrockruntime-29758.json new file mode 100644 index 0000000000..6f4470b702 --- /dev/null +++ b/.changes/next-release/api-change-bedrockruntime-29758.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``bedrock-runtime``", + "description": "This release adds support for minor versions/aliases for invoke model identifier." +} diff --git a/.changes/next-release/api-change-connect-51996.json b/.changes/next-release/api-change-connect-51996.json new file mode 100644 index 0000000000..b7007b75e8 --- /dev/null +++ b/.changes/next-release/api-change-connect-51996.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``connect``", + "description": "Added support for following capabilities: Amazon Connect's in-app, web, and video calling. Two-way SMS integrations. Contact Lens real-time chat analytics feature. Amazon Connect Analytics Datalake capability. Capability to configure real time chat rules." +} diff --git a/.changes/next-release/api-change-customerprofiles-94400.json b/.changes/next-release/api-change-customerprofiles-94400.json new file mode 100644 index 0000000000..fb8874fa9b --- /dev/null +++ b/.changes/next-release/api-change-customerprofiles-94400.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``customer-profiles``", + "description": "This release introduces DetectProfileObjectType API to auto generate object type mapping." +} diff --git a/.changes/next-release/api-change-endpointrules-96440.json b/.changes/next-release/api-change-endpointrules-96440.json new file mode 100644 index 0000000000..00deedc0ca --- /dev/null +++ b/.changes/next-release/api-change-endpointrules-96440.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``endpoint-rules``", + "description": "Update endpoint-rules client to latest version" +} diff --git a/.changes/next-release/api-change-qbusiness-11571.json b/.changes/next-release/api-change-qbusiness-11571.json new file mode 100644 index 0000000000..c4f78c862a --- /dev/null +++ b/.changes/next-release/api-change-qbusiness-11571.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``qbusiness``", + "description": "Amazon Q - a generative AI powered application that your employees can use to ask questions and get answers from knowledge spread across disparate content repositories, summarize reports, write articles, take actions, and much more - all within their company's connected content repositories." +} diff --git a/.changes/next-release/api-change-qconnect-80765.json b/.changes/next-release/api-change-qconnect-80765.json new file mode 100644 index 0000000000..d5c1c6d0ec --- /dev/null +++ b/.changes/next-release/api-change-qconnect-80765.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``qconnect``", + "description": "Amazon Q in Connect, an LLM-enhanced evolution of Amazon Connect Wisdom. This release adds generative AI support to Amazon Q Connect QueryAssistant and GetRecommendations APIs." +} diff --git a/.changes/next-release/api-change-s3-30237.json b/.changes/next-release/api-change-s3-30237.json new file mode 100644 index 0000000000..8d5fb40230 --- /dev/null +++ b/.changes/next-release/api-change-s3-30237.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``s3``", + "description": "Adds support for S3 Express One Zone." +} diff --git a/.changes/next-release/api-change-s3control-97162.json b/.changes/next-release/api-change-s3control-97162.json new file mode 100644 index 0000000000..2bf026ee14 --- /dev/null +++ b/.changes/next-release/api-change-s3control-97162.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``s3control``", + "description": "Adds support for S3 Express One Zone, and InvocationSchemaVersion 2.0 for S3 Batch Operations." +} diff --git a/botocore/data/accessanalyzer/2019-11-01/service-2.json b/botocore/data/accessanalyzer/2019-11-01/service-2.json index 92cd8f738e..fe9909cdfe 100644 --- a/botocore/data/accessanalyzer/2019-11-01/service-2.json +++ b/botocore/data/accessanalyzer/2019-11-01/service-2.json @@ -1292,7 +1292,7 @@ }, "s3Bucket":{ "shape":"S3BucketConfiguration", - "documentation":"

The access control configuration is for an Amazon S3 Bucket.

" + "documentation":"

The access control configuration is for an Amazon S3 bucket.

" }, "snsTopic":{ "shape":"SnsTopicConfiguration", @@ -1301,6 +1301,10 @@ "sqsQueue":{ "shape":"SqsQueueConfiguration", "documentation":"

The access control configuration is for an Amazon SQS queue.

" + }, + "s3ExpressDirectoryBucket":{ + "shape":"S3ExpressDirectoryBucketConfiguration", + "documentation":"

The access control configuration is for an Amazon S3 directory bucket.

" } }, "documentation":"

Access control configuration structures for your resource. You specify the configuration as a type-value pair. You can specify only one type of access control configuration.

", @@ -3171,7 +3175,8 @@ "AWS::ECR::Repository", "AWS::RDS::DBSnapshot", "AWS::RDS::DBClusterSnapshot", - "AWS::SNS::Topic" + "AWS::SNS::Topic", + "AWS::S3Express::DirectoryBucket" ] }, "RetiringPrincipal":{"type":"string"}, @@ -3247,6 +3252,17 @@ "documentation":"

Proposed access control configuration for an Amazon S3 bucket. You can propose a configuration for a new Amazon S3 bucket or an existing Amazon S3 bucket that you own by specifying the Amazon S3 bucket policy, bucket ACLs, bucket BPA settings, Amazon S3 access points, and multi-region access points attached to the bucket. If the configuration is for an existing Amazon S3 bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the existing policy attached to the bucket. If the access preview is for a new resource and you do not specify the Amazon S3 bucket policy, the access preview assumes a bucket without a policy. To propose deletion of an existing bucket policy, you can specify an empty string. For more information about bucket policy limits, see Bucket Policy Examples.

" }, "S3BucketPolicy":{"type":"string"}, + "S3ExpressDirectoryBucketConfiguration":{ + "type":"structure", + "members":{ + "bucketPolicy":{ + "shape":"S3ExpressDirectoryBucketPolicy", + "documentation":"

The proposed bucket policy for the Amazon S3 directory bucket.

" + } + }, + "documentation":"

Proposed access control configuration for an Amazon S3 directory bucket. You can propose a configuration for a new Amazon S3 directory bucket or an existing Amazon S3 directory bucket that you own by specifying the Amazon S3 bucket policy. If the configuration is for an existing Amazon S3 directory bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the existing policy attached to the directory bucket. If the access preview is for a new resource and you do not specify the Amazon S3 bucket policy, the access preview assumes an directory bucket without a policy. To propose deletion of an existing bucket policy, you can specify an empty string. For more information about bucket policy limits, see Example bucket policies.

" + }, + "S3ExpressDirectoryBucketPolicy":{"type":"string"}, "S3PublicAccessBlockConfiguration":{ "type":"structure", "required":[ diff --git a/botocore/data/bedrock-agent-runtime/2023-07-26/endpoint-rule-set-1.json b/botocore/data/bedrock-agent-runtime/2023-07-26/endpoint-rule-set-1.json new file mode 100644 index 0000000000..950c867886 --- /dev/null +++ b/botocore/data/bedrock-agent-runtime/2023-07-26/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/botocore/data/bedrock-agent-runtime/2023-07-26/paginators-1.json b/botocore/data/bedrock-agent-runtime/2023-07-26/paginators-1.json new file mode 100644 index 0000000000..bd57dfbc67 --- /dev/null +++ b/botocore/data/bedrock-agent-runtime/2023-07-26/paginators-1.json @@ -0,0 +1,9 @@ +{ + "pagination": { + "Retrieve": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "retrievalResults" + } + } +} diff --git a/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json b/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json new file mode 100644 index 0000000000..9677842f01 --- /dev/null +++ b/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json @@ -0,0 +1,1081 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2023-07-26", + "endpointPrefix":"bedrock-agent-runtime", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Agents for Amazon Bedrock Runtime", + "serviceId":"Bedrock Agent Runtime", + "signatureVersion":"v4", + "signingName":"bedrock", + "uid":"bedrock-agent-runtime-2023-07-26" + }, + "operations":{ + "InvokeAgent":{ + "name":"InvokeAgent", + "http":{ + "method":"POST", + "requestUri":"/agents/{agentId}/agentAliases/{agentAliasId}/sessions/{sessionId}/text", + "responseCode":200 + }, + "input":{"shape":"InvokeAgentRequest"}, + "output":{"shape":"InvokeAgentResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"DependencyFailedException"}, + {"shape":"BadGatewayException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Invokes the specified Bedrock model to run inference using the input provided in the request body.

" + }, + "Retrieve":{ + "name":"Retrieve", + "http":{ + "method":"POST", + "requestUri":"/knowledgebases/{knowledgeBaseId}/retrieve", + "responseCode":200 + }, + "input":{"shape":"RetrieveRequest"}, + "output":{"shape":"RetrieveResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"DependencyFailedException"}, + {"shape":"BadGatewayException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Retrieve from knowledge base.

" + }, + "RetrieveAndGenerate":{ + "name":"RetrieveAndGenerate", + "http":{ + "method":"POST", + "requestUri":"/retrieveAndGenerate", + "responseCode":200 + }, + "input":{"shape":"RetrieveAndGenerateRequest"}, + "output":{"shape":"RetrieveAndGenerateResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"DependencyFailedException"}, + {"shape":"BadGatewayException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

RetrieveAndGenerate API

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when a request is denied per access permissions

", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ActionGroupInvocationInput":{ + "type":"structure", + "members":{ + "actionGroupName":{"shape":"ActionGroupName"}, + "verb":{"shape":"Verb"}, + "apiPath":{"shape":"ApiPath"}, + "parameters":{"shape":"Parameters"}, + "requestBody":{"shape":"RequestBody"} + }, + "documentation":"

input to lambda used in action group

" + }, + "ActionGroupInvocationOutput":{ + "type":"structure", + "members":{ + "text":{"shape":"ActionGroupOutputString"} + }, + "documentation":"

output from lambda used in action group

" + }, + "ActionGroupName":{ + "type":"string", + "documentation":"

Agent Trace Action Group Name

", + "sensitive":true + }, + "ActionGroupOutputString":{ + "type":"string", + "documentation":"

Agent Trace Action Group Lambda Invocation Output String

", + "sensitive":true + }, + "AgentAliasId":{ + "type":"string", + "documentation":"

Identifier of the agent alias.

", + "max":10, + "min":0, + "pattern":"[0-9a-zA-Z]+" + }, + "AgentId":{ + "type":"string", + "documentation":"

Identifier of the agent.

", + "max":10, + "min":0, + "pattern":"[0-9a-zA-Z]+" + }, + "ApiPath":{ + "type":"string", + "documentation":"

Agent Trace Action Group API path

", + "sensitive":true + }, + "Attribution":{ + "type":"structure", + "members":{ + "citations":{"shape":"Citations"} + }, + "documentation":"

Citations associated with final agent response

" + }, + "BadGatewayException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"}, + "resourceName":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource

", + "error":{"httpStatusCode":502}, + "exception":true, + "fault":true + }, + "BedrockModelArn":{ + "type":"string", + "documentation":"

Arn of a Bedrock model.

", + "max":1011, + "min":20, + "pattern":"arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))" + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "Citation":{ + "type":"structure", + "members":{ + "generatedResponsePart":{"shape":"GeneratedResponsePart"}, + "retrievedReferences":{"shape":"RetrievedReferences"} + }, + "documentation":"

Citation associated with the agent response

" + }, + "Citations":{ + "type":"list", + "member":{"shape":"Citation"}, + "documentation":"

List of citations

" + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when there is a conflict performing an operation

", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ContentMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Parameters"}, + "documentation":"

Content type paramter map

" + }, + "CreationMode":{ + "type":"string", + "documentation":"

indicates if agent uses default prompt or overriden prompt

", + "enum":[ + "DEFAULT", + "OVERRIDDEN" + ] + }, + "DependencyFailedException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"}, + "resourceName":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)

", + "error":{ + "httpStatusCode":424, + "senderFault":true + }, + "exception":true + }, + "Double":{ + "type":"double", + "box":true + }, + "FailureReasonString":{ + "type":"string", + "documentation":"

Agent Trace Failed Reason String

", + "sensitive":true + }, + "FailureTrace":{ + "type":"structure", + "members":{ + "traceId":{"shape":"TraceId"}, + "failureReason":{"shape":"FailureReasonString"} + }, + "documentation":"

Trace Part which is emitted when agent trace could not be generated

", + "sensitive":true + }, + "FinalResponse":{ + "type":"structure", + "members":{ + "text":{"shape":"FinalResponseString"} + }, + "documentation":"

Agent finish output

" + }, + "FinalResponseString":{ + "type":"string", + "documentation":"

Agent Trace Action Group Lambda Invocation Output String

", + "sensitive":true + }, + "GeneratedResponsePart":{ + "type":"structure", + "members":{ + "textResponsePart":{"shape":"TextResponsePart"} + }, + "documentation":"

Generate response part

" + }, + "InferenceConfiguration":{ + "type":"structure", + "members":{ + "temperature":{"shape":"Temperature"}, + "topP":{"shape":"TopP"}, + "topK":{"shape":"TopK"}, + "maximumLength":{"shape":"MaximumLength"}, + "stopSequences":{"shape":"StopSequences"} + }, + "documentation":"

Configurations for controlling the inference response of an InvokeAgent API call

" + }, + "InputText":{ + "type":"string", + "documentation":"

Model text input

", + "max":25000000, + "min":0, + "sensitive":true + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown if there was an unexpected error during processing of request

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvocationInput":{ + "type":"structure", + "members":{ + "traceId":{"shape":"TraceId"}, + "invocationType":{"shape":"InvocationType"}, + "actionGroupInvocationInput":{"shape":"ActionGroupInvocationInput"}, + "knowledgeBaseLookupInput":{"shape":"KnowledgeBaseLookupInput"} + }, + "documentation":"

Trace Part which contains input details for action group or knowledge base

", + "sensitive":true + }, + "InvocationType":{ + "type":"string", + "documentation":"

types of invocations

", + "enum":[ + "ACTION_GROUP", + "KNOWLEDGE_BASE", + "FINISH" + ] + }, + "InvokeAgentRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentAliasId", + "sessionId", + "inputText" + ], + "members":{ + "sessionState":{ + "shape":"SessionState", + "documentation":"

Session state passed by customer. Base64 encoded json string representation of SessionState.

" + }, + "agentId":{ + "shape":"AgentId", + "documentation":"

Identifier for Agent

", + "location":"uri", + "locationName":"agentId" + }, + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"

Identifier for Agent Alias

", + "location":"uri", + "locationName":"agentAliasId" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"

Identifier used for the current session

", + "location":"uri", + "locationName":"sessionId" + }, + "endSession":{ + "shape":"Boolean", + "documentation":"

End current session

" + }, + "enableTrace":{ + "shape":"Boolean", + "documentation":"

Enable agent trace events for improved debugging

" + }, + "inputText":{ + "shape":"InputText", + "documentation":"

Input data in the format specified in the Content-Type request header.

" + } + }, + "documentation":"

InvokeAgent Request

" + }, + "InvokeAgentResponse":{ + "type":"structure", + "required":[ + "completion", + "contentType", + "sessionId" + ], + "members":{ + "completion":{ + "shape":"ResponseStream", + "documentation":"

Inference response from the model in the format specified in the Content-Type response header.

" + }, + "contentType":{ + "shape":"MimeType", + "documentation":"

streaming response mimetype of the model

", + "location":"header", + "locationName":"x-amzn-bedrock-agent-content-type" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"

streaming response mimetype of the model

", + "location":"header", + "locationName":"x-amz-bedrock-agent-session-id" + } + }, + "documentation":"

InvokeAgent Response

", + "payload":"completion" + }, + "KmsKeyArn":{ + "type":"string", + "documentation":"

A KMS key ARN

", + "max":2048, + "min":1, + "pattern":"arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}" + }, + "KnowledgeBaseId":{ + "type":"string", + "documentation":"

Identifier of the KnowledgeBase

", + "max":10, + "min":0, + "pattern":"[0-9a-zA-Z]+" + }, + "KnowledgeBaseLookupInput":{ + "type":"structure", + "members":{ + "text":{"shape":"KnowledgeBaseLookupInputString"}, + "knowledgeBaseId":{"shape":"TraceKnowledgeBaseId"} + }, + "documentation":"

Input to lambda used in action group

" + }, + "KnowledgeBaseLookupInputString":{ + "type":"string", + "documentation":"

Agent Trace Action Group Lambda Invocation Output String

", + "sensitive":true + }, + "KnowledgeBaseLookupOutput":{ + "type":"structure", + "members":{ + "retrievedReferences":{"shape":"RetrievedReferences"} + }, + "documentation":"

Input to lambda used in action group

" + }, + "KnowledgeBaseQuery":{ + "type":"structure", + "required":["text"], + "members":{ + "text":{ + "shape":"KnowledgeBaseQueryTextString", + "documentation":"

Knowledge base input query in text

" + } + }, + "documentation":"

Knowledge base input query.

", + "sensitive":true + }, + "KnowledgeBaseQueryTextString":{ + "type":"string", + "max":1000, + "min":0 + }, + "KnowledgeBaseRetrievalConfiguration":{ + "type":"structure", + "required":["vectorSearchConfiguration"], + "members":{ + "vectorSearchConfiguration":{"shape":"KnowledgeBaseVectorSearchConfiguration"} + }, + "documentation":"

Search parameters for retrieving from knowledge base.

" + }, + "KnowledgeBaseRetrievalResult":{ + "type":"structure", + "required":["content"], + "members":{ + "content":{"shape":"RetrievalResultContent"}, + "location":{"shape":"RetrievalResultLocation"}, + "score":{ + "shape":"Double", + "documentation":"

The relevance score of a result.

" + } + }, + "documentation":"

Result item returned from a knowledge base retrieval.

" + }, + "KnowledgeBaseRetrievalResults":{ + "type":"list", + "member":{"shape":"KnowledgeBaseRetrievalResult"}, + "documentation":"

List of knowledge base retrieval results

", + "sensitive":true + }, + "KnowledgeBaseRetrieveAndGenerateConfiguration":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "modelArn" + ], + "members":{ + "knowledgeBaseId":{"shape":"KnowledgeBaseId"}, + "modelArn":{"shape":"BedrockModelArn"} + }, + "documentation":"

Configurations for retrieval and generation for knowledge base.

" + }, + "KnowledgeBaseVectorSearchConfiguration":{ + "type":"structure", + "required":["numberOfResults"], + "members":{ + "numberOfResults":{ + "shape":"KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger", + "documentation":"

Top-K results to retrieve from knowledge base.

" + } + }, + "documentation":"

Knowledge base vector search configuration

" + }, + "KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "LambdaArn":{ + "type":"string", + "documentation":"

ARN of a Lambda.

" + }, + "MaximumLength":{ + "type":"integer", + "documentation":"

Maximum length of output

", + "box":true, + "max":4096, + "min":0 + }, + "MimeType":{ + "type":"string", + "documentation":"

Content type of the request

" + }, + "ModelInvocationInput":{ + "type":"structure", + "members":{ + "traceId":{"shape":"TraceId"}, + "text":{"shape":"PromptText"}, + "type":{"shape":"PromptType"}, + "inferenceConfiguration":{"shape":"InferenceConfiguration"}, + "overrideLambda":{"shape":"LambdaArn"}, + "promptCreationMode":{"shape":"CreationMode"}, + "parserMode":{"shape":"CreationMode"} + }, + "documentation":"

Trace Part which contains information used to call Invoke Model

", + "sensitive":true + }, + "NextToken":{ + "type":"string", + "documentation":"

Opaque continuation token of previous paginated response.

", + "max":2048, + "min":1, + "pattern":"\\S*" + }, + "NonBlankString":{ + "type":"string", + "documentation":"

Non Blank String

", + "pattern":"[\\s\\S]*" + }, + "Observation":{ + "type":"structure", + "members":{ + "traceId":{"shape":"TraceId"}, + "type":{"shape":"Type"}, + "actionGroupInvocationOutput":{"shape":"ActionGroupInvocationOutput"}, + "knowledgeBaseLookupOutput":{"shape":"KnowledgeBaseLookupOutput"}, + "finalResponse":{"shape":"FinalResponse"}, + "repromptResponse":{"shape":"RepromptResponse"} + }, + "documentation":"

Trace Part which contains output details for action group or knowledge base or final response

", + "sensitive":true + }, + "OrchestrationTrace":{ + "type":"structure", + "members":{ + "rationale":{"shape":"Rationale"}, + "invocationInput":{"shape":"InvocationInput"}, + "observation":{"shape":"Observation"}, + "modelInvocationInput":{"shape":"ModelInvocationInput"} + }, + "documentation":"

Trace contains intermidate response during orchestration

", + "sensitive":true, + "union":true + }, + "OutputString":{ + "type":"string", + "documentation":"

Agent Trace Output String

", + "sensitive":true + }, + "Parameter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

Name of parameter

" + }, + "type":{ + "shape":"String", + "documentation":"

Type of parameter

" + }, + "value":{ + "shape":"String", + "documentation":"

Value of parameter

" + } + }, + "documentation":"

parameters included in action group invocation

" + }, + "Parameters":{ + "type":"list", + "member":{"shape":"Parameter"}, + "documentation":"

list of parameters included in action group invocation

" + }, + "PartBody":{ + "type":"blob", + "documentation":"

PartBody of the payload in bytes

", + "max":1000000, + "min":0, + "sensitive":true + }, + "PayloadPart":{ + "type":"structure", + "members":{ + "bytes":{"shape":"PartBody"}, + "attribution":{"shape":"Attribution"} + }, + "documentation":"

Base 64 endoded byte response

", + "event":true, + "sensitive":true + }, + "PostProcessingModelInvocationOutput":{ + "type":"structure", + "members":{ + "traceId":{"shape":"TraceId"}, + "parsedResponse":{"shape":"PostProcessingParsedResponse"} + }, + "documentation":"

Trace Part which contains information related to postprocessing

", + "sensitive":true + }, + "PostProcessingParsedResponse":{ + "type":"structure", + "members":{ + "text":{"shape":"OutputString"} + }, + "documentation":"

Trace Part which contains information if preprocessing was successful

", + "sensitive":true + }, + "PostProcessingTrace":{ + "type":"structure", + "members":{ + "modelInvocationInput":{"shape":"ModelInvocationInput"}, + "modelInvocationOutput":{"shape":"PostProcessingModelInvocationOutput"} + }, + "documentation":"

Trace Part which contains information related to post processing step

", + "sensitive":true, + "union":true + }, + "PreProcessingModelInvocationOutput":{ + "type":"structure", + "members":{ + "traceId":{"shape":"TraceId"}, + "parsedResponse":{"shape":"PreProcessingParsedResponse"} + }, + "documentation":"

Trace Part which contains information related to preprocessing

", + "sensitive":true + }, + "PreProcessingParsedResponse":{ + "type":"structure", + "members":{ + "rationale":{"shape":"RationaleString"}, + "isValid":{ + "shape":"Boolean", + "documentation":"

Boolean value

" + } + }, + "documentation":"

Trace Part which contains information if preprocessing was successful

", + "sensitive":true + }, + "PreProcessingTrace":{ + "type":"structure", + "members":{ + "modelInvocationInput":{"shape":"ModelInvocationInput"}, + "modelInvocationOutput":{"shape":"PreProcessingModelInvocationOutput"} + }, + "documentation":"

Trace Part which contains information related to preprocessing step

", + "sensitive":true, + "union":true + }, + "PromptSessionAttributesMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"}, + "documentation":"

Session attributes that go to the prompt

" + }, + "PromptText":{ + "type":"string", + "documentation":"

Prompt Message

", + "sensitive":true + }, + "PromptType":{ + "type":"string", + "documentation":"

types of prompts

", + "enum":[ + "PRE_PROCESSING", + "ORCHESTRATION", + "KNOWLEDGE_BASE_RESPONSE_GENERATION", + "POST_PROCESSING" + ] + }, + "Rationale":{ + "type":"structure", + "members":{ + "traceId":{"shape":"TraceId"}, + "text":{"shape":"RationaleString"} + }, + "documentation":"

Trace Part which contains information related to reasoning

", + "sensitive":true + }, + "RationaleString":{ + "type":"string", + "documentation":"

Agent Trace Rationale String

", + "sensitive":true + }, + "RepromptResponse":{ + "type":"structure", + "members":{ + "text":{ + "shape":"String", + "documentation":"

Reprompt response text

" + }, + "source":{"shape":"Source"} + }, + "documentation":"

Observation information if there were reprompts

", + "sensitive":true + }, + "RequestBody":{ + "type":"structure", + "members":{ + "content":{"shape":"ContentMap"} + }, + "documentation":"

Request Body Content Map

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when a resource referenced by the operation does not exist

", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResponseStream":{ + "type":"structure", + "members":{ + "chunk":{"shape":"PayloadPart"}, + "trace":{"shape":"TracePart"}, + "internalServerException":{"shape":"InternalServerException"}, + "validationException":{"shape":"ValidationException"}, + "resourceNotFoundException":{"shape":"ResourceNotFoundException"}, + "serviceQuotaExceededException":{"shape":"ServiceQuotaExceededException"}, + "throttlingException":{"shape":"ThrottlingException"}, + "accessDeniedException":{"shape":"AccessDeniedException"}, + "conflictException":{"shape":"ConflictException"}, + "dependencyFailedException":{"shape":"DependencyFailedException"}, + "badGatewayException":{"shape":"BadGatewayException"} + }, + "documentation":"

Response body of is a stream

", + "eventstream":true + }, + "RetrievalResultContent":{ + "type":"structure", + "required":["text"], + "members":{ + "text":{ + "shape":"String", + "documentation":"

Content of a retrieval result in text

" + } + }, + "documentation":"

Content of a retrieval result.

" + }, + "RetrievalResultLocation":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{"shape":"RetrievalResultLocationType"}, + "s3Location":{"shape":"RetrievalResultS3Location"} + }, + "documentation":"

The source location of a retrieval result.

" + }, + "RetrievalResultLocationType":{ + "type":"string", + "documentation":"

The location type of a retrieval result.

", + "enum":["S3"] + }, + "RetrievalResultS3Location":{ + "type":"structure", + "members":{ + "uri":{ + "shape":"String", + "documentation":"

URI of S3 location

" + } + }, + "documentation":"

The S3 location of a retrieval result.

" + }, + "RetrieveAndGenerateConfiguration":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{"shape":"RetrieveAndGenerateType"}, + "knowledgeBaseConfiguration":{"shape":"KnowledgeBaseRetrieveAndGenerateConfiguration"} + }, + "documentation":"

Configures the retrieval and generation for the session.

" + }, + "RetrieveAndGenerateInput":{ + "type":"structure", + "required":["text"], + "members":{ + "text":{ + "shape":"RetrieveAndGenerateInputTextString", + "documentation":"

Customer input of the turn in text

" + } + }, + "documentation":"

Customer input of the turn

", + "sensitive":true + }, + "RetrieveAndGenerateInputTextString":{ + "type":"string", + "max":1000, + "min":0 + }, + "RetrieveAndGenerateOutput":{ + "type":"structure", + "required":["text"], + "members":{ + "text":{ + "shape":"String", + "documentation":"

Service response of the turn in text

" + } + }, + "documentation":"

Service response of the turn

", + "sensitive":true + }, + "RetrieveAndGenerateRequest":{ + "type":"structure", + "required":["input"], + "members":{ + "sessionId":{"shape":"SessionId"}, + "input":{"shape":"RetrieveAndGenerateInput"}, + "retrieveAndGenerateConfiguration":{"shape":"RetrieveAndGenerateConfiguration"}, + "sessionConfiguration":{"shape":"RetrieveAndGenerateSessionConfiguration"} + } + }, + "RetrieveAndGenerateResponse":{ + "type":"structure", + "required":[ + "sessionId", + "output" + ], + "members":{ + "sessionId":{"shape":"SessionId"}, + "output":{"shape":"RetrieveAndGenerateOutput"}, + "citations":{"shape":"Citations"} + } + }, + "RetrieveAndGenerateSessionConfiguration":{ + "type":"structure", + "required":["kmsKeyArn"], + "members":{ + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"

The KMS key arn to encrypt the customer data of the session.

" + } + }, + "documentation":"

Configures common parameters of the session.

" + }, + "RetrieveAndGenerateType":{ + "type":"string", + "documentation":"

The type of RetrieveAndGenerate.

", + "enum":["KNOWLEDGE_BASE"] + }, + "RetrieveRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "retrievalQuery" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"KnowledgeBaseId", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "retrievalQuery":{"shape":"KnowledgeBaseQuery"}, + "retrievalConfiguration":{"shape":"KnowledgeBaseRetrievalConfiguration"}, + "nextToken":{"shape":"NextToken"} + } + }, + "RetrieveResponse":{ + "type":"structure", + "required":["retrievalResults"], + "members":{ + "retrievalResults":{"shape":"KnowledgeBaseRetrievalResults"}, + "nextToken":{"shape":"NextToken"} + } + }, + "RetrievedReference":{ + "type":"structure", + "members":{ + "content":{"shape":"RetrievalResultContent"}, + "location":{"shape":"RetrievalResultLocation"} + }, + "documentation":"

Retrieved reference

" + }, + "RetrievedReferences":{ + "type":"list", + "member":{"shape":"RetrievedReference"}, + "documentation":"

list of retrieved references

" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when a request is made beyond the service quota

", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SessionAttributesMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"}, + "documentation":"

Session attributes are pass through attributes passed to the action group

" + }, + "SessionId":{ + "type":"string", + "documentation":"

Identifier of the session.

", + "max":100, + "min":2, + "pattern":"[0-9a-zA-Z._:-]+" + }, + "SessionState":{ + "type":"structure", + "members":{ + "sessionAttributes":{ + "shape":"SessionAttributesMap", + "documentation":"

Session Attributes

" + }, + "promptSessionAttributes":{ + "shape":"PromptSessionAttributesMap", + "documentation":"

Prompt Session Attributes

" + } + }, + "documentation":"

Session state provided

" + }, + "Source":{ + "type":"string", + "documentation":"

Parsing error source

", + "enum":[ + "ACTION_GROUP", + "KNOWLEDGE_BASE", + "PARSER" + ], + "sensitive":true + }, + "Span":{ + "type":"structure", + "members":{ + "start":{ + "shape":"SpanStartInteger", + "documentation":"

Start of span

" + }, + "end":{ + "shape":"SpanEndInteger", + "documentation":"

End of span

" + } + }, + "documentation":"

Span of text

" + }, + "SpanEndInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "SpanStartInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "StopSequences":{ + "type":"list", + "member":{"shape":"String"}, + "documentation":"

List of stop sequences

", + "max":4, + "min":0 + }, + "String":{"type":"string"}, + "Temperature":{ + "type":"float", + "documentation":"

Controls randomness, higher values increase diversity

", + "box":true, + "max":1, + "min":0 + }, + "TextResponsePart":{ + "type":"structure", + "members":{ + "text":{ + "shape":"String", + "documentation":"

Response part in text

" + }, + "span":{"shape":"Span"} + }, + "documentation":"

Text response part

" + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when the number of requests exceeds the limit

", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "TopK":{ + "type":"integer", + "documentation":"

Sample from the k most likely next tokens

", + "box":true, + "max":500, + "min":0 + }, + "TopP":{ + "type":"float", + "documentation":"

Cumulative probability cutoff for token selection

", + "box":true, + "max":1, + "min":0 + }, + "Trace":{ + "type":"structure", + "members":{ + "preProcessingTrace":{"shape":"PreProcessingTrace"}, + "orchestrationTrace":{"shape":"OrchestrationTrace"}, + "postProcessingTrace":{"shape":"PostProcessingTrace"}, + "failureTrace":{"shape":"FailureTrace"} + }, + "documentation":"

Trace contains intermidate response for customer

", + "sensitive":true, + "union":true + }, + "TraceId":{ + "type":"string", + "documentation":"

Identifier for trace

", + "max":16, + "min":2 + }, + "TraceKnowledgeBaseId":{ + "type":"string", + "documentation":"

Agent Trace Action Group Knowledge Base Id

", + "sensitive":true + }, + "TracePart":{ + "type":"structure", + "members":{ + "agentId":{"shape":"AgentId"}, + "agentAliasId":{"shape":"AgentAliasId"}, + "sessionId":{"shape":"SessionId"}, + "trace":{"shape":"Trace"} + }, + "documentation":"

Trace Part which contains intermidate response for customer

", + "event":true, + "sensitive":true + }, + "Type":{ + "type":"string", + "documentation":"

types of observations

", + "enum":[ + "ACTION_GROUP", + "KNOWLEDGE_BASE", + "FINISH", + "ASK_USER", + "REPROMPT" + ] + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when the request's input validation fails

", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Verb":{ + "type":"string", + "documentation":"

Agent Trace Action Group Action verb

", + "sensitive":true + } + }, + "documentation":"

Amazon Bedrock Agent

" +} diff --git a/botocore/data/bedrock-agent/2023-06-05/endpoint-rule-set-1.json b/botocore/data/bedrock-agent/2023-06-05/endpoint-rule-set-1.json new file mode 100644 index 0000000000..e88af541bb --- /dev/null +++ b/botocore/data/bedrock-agent/2023-06-05/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/botocore/data/bedrock-agent/2023-06-05/paginators-1.json b/botocore/data/bedrock-agent/2023-06-05/paginators-1.json new file mode 100644 index 0000000000..8e00fb72a9 --- /dev/null +++ b/botocore/data/bedrock-agent/2023-06-05/paginators-1.json @@ -0,0 +1,52 @@ +{ + "pagination": { + "ListAgentActionGroups": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "actionGroupSummaries" + }, + "ListAgentAliases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "agentAliasSummaries" + }, + "ListAgentKnowledgeBases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "agentKnowledgeBaseSummaries" + }, + "ListAgentVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "agentVersionSummaries" + }, + "ListAgents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "agentSummaries" + }, + "ListDataSources": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "dataSourceSummaries" + }, + "ListIngestionJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "ingestionJobSummaries" + }, + "ListKnowledgeBases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "knowledgeBaseSummaries" + } + } +} diff --git a/botocore/data/bedrock-agent/2023-06-05/service-2.json b/botocore/data/bedrock-agent/2023-06-05/service-2.json new file mode 100644 index 0000000000..02f9a845e5 --- /dev/null +++ b/botocore/data/bedrock-agent/2023-06-05/service-2.json @@ -0,0 +1,3358 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2023-06-05", + "endpointPrefix":"bedrock-agent", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Agents for Amazon Bedrock", + "serviceId":"Bedrock Agent", + "signatureVersion":"v4", + "signingName":"bedrock", + "uid":"bedrock-agent-2023-06-05" + }, + "operations":{ + "AssociateAgentKnowledgeBase":{ + "name":"AssociateAgentKnowledgeBase", + "http":{ + "method":"PUT", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/", + "responseCode":200 + }, + "input":{"shape":"AssociateAgentKnowledgeBaseRequest"}, + "output":{"shape":"AssociateAgentKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Associate a Knowledge Base to an existing Amazon Bedrock Agent

", + "idempotent":true + }, + "CreateAgent":{ + "name":"CreateAgent", + "http":{ + "method":"PUT", + "requestUri":"/agents/", + "responseCode":202 + }, + "input":{"shape":"CreateAgentRequest"}, + "output":{"shape":"CreateAgentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates an Amazon Bedrock Agent

", + "idempotent":true + }, + "CreateAgentActionGroup":{ + "name":"CreateAgentActionGroup", + "http":{ + "method":"PUT", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/actiongroups/", + "responseCode":200 + }, + "input":{"shape":"CreateAgentActionGroupRequest"}, + "output":{"shape":"CreateAgentActionGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates an Action Group for existing Amazon Bedrock Agent

", + "idempotent":true + }, + "CreateAgentAlias":{ + "name":"CreateAgentAlias", + "http":{ + "method":"PUT", + "requestUri":"/agents/{agentId}/agentaliases/", + "responseCode":202 + }, + "input":{"shape":"CreateAgentAliasRequest"}, + "output":{"shape":"CreateAgentAliasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates an Alias for an existing Amazon Bedrock Agent

", + "idempotent":true + }, + "CreateDataSource":{ + "name":"CreateDataSource", + "http":{ + "method":"PUT", + "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/", + "responseCode":200 + }, + "input":{"shape":"CreateDataSourceRequest"}, + "output":{"shape":"CreateDataSourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Create a new data source

", + "idempotent":true + }, + "CreateKnowledgeBase":{ + "name":"CreateKnowledgeBase", + "http":{ + "method":"PUT", + "requestUri":"/knowledgebases/", + "responseCode":202 + }, + "input":{"shape":"CreateKnowledgeBaseRequest"}, + "output":{"shape":"CreateKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Create a new knowledge base

", + "idempotent":true + }, + "DeleteAgent":{ + "name":"DeleteAgent", + "http":{ + "method":"DELETE", + "requestUri":"/agents/{agentId}/", + "responseCode":202 + }, + "input":{"shape":"DeleteAgentRequest"}, + "output":{"shape":"DeleteAgentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Deletes an Agent for existing Amazon Bedrock Agent

", + "idempotent":true + }, + "DeleteAgentActionGroup":{ + "name":"DeleteAgentActionGroup", + "http":{ + "method":"DELETE", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/", + "responseCode":204 + }, + "input":{"shape":"DeleteAgentActionGroupRequest"}, + "output":{"shape":"DeleteAgentActionGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Deletes an Action Group for existing Amazon Bedrock Agent.

", + "idempotent":true + }, + "DeleteAgentAlias":{ + "name":"DeleteAgentAlias", + "http":{ + "method":"DELETE", + "requestUri":"/agents/{agentId}/agentaliases/{agentAliasId}/", + "responseCode":202 + }, + "input":{"shape":"DeleteAgentAliasRequest"}, + "output":{"shape":"DeleteAgentAliasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes an Alias for a Amazon Bedrock Agent

", + "idempotent":true + }, + "DeleteAgentVersion":{ + "name":"DeleteAgentVersion", + "http":{ + "method":"DELETE", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/", + "responseCode":202 + }, + "input":{"shape":"DeleteAgentVersionRequest"}, + "output":{"shape":"DeleteAgentVersionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Deletes an Agent version for existing Amazon Bedrock Agent

", + "idempotent":true + }, + "DeleteDataSource":{ + "name":"DeleteDataSource", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}", + "responseCode":202 + }, + "input":{"shape":"DeleteDataSourceRequest"}, + "output":{"shape":"DeleteDataSourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Delete an existing data source

", + "idempotent":true + }, + "DeleteKnowledgeBase":{ + "name":"DeleteKnowledgeBase", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgebases/{knowledgeBaseId}", + "responseCode":202 + }, + "input":{"shape":"DeleteKnowledgeBaseRequest"}, + "output":{"shape":"DeleteKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Delete an existing knowledge base

", + "idempotent":true + }, + "DisassociateAgentKnowledgeBase":{ + "name":"DisassociateAgentKnowledgeBase", + "http":{ + "method":"DELETE", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/", + "responseCode":204 + }, + "input":{"shape":"DisassociateAgentKnowledgeBaseRequest"}, + "output":{"shape":"DisassociateAgentKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Disassociate an existing Knowledge Base from an Amazon Bedrock Agent

", + "idempotent":true + }, + "GetAgent":{ + "name":"GetAgent", + "http":{ + "method":"GET", + "requestUri":"/agents/{agentId}/", + "responseCode":200 + }, + "input":{"shape":"GetAgentRequest"}, + "output":{"shape":"GetAgentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets an Agent for existing Amazon Bedrock Agent

" + }, + "GetAgentActionGroup":{ + "name":"GetAgentActionGroup", + "http":{ + "method":"GET", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/", + "responseCode":200 + }, + "input":{"shape":"GetAgentActionGroupRequest"}, + "output":{"shape":"GetAgentActionGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets an Action Group for existing Amazon Bedrock Agent Version

" + }, + "GetAgentAlias":{ + "name":"GetAgentAlias", + "http":{ + "method":"GET", + "requestUri":"/agents/{agentId}/agentaliases/{agentAliasId}/", + "responseCode":200 + }, + "input":{"shape":"GetAgentAliasRequest"}, + "output":{"shape":"GetAgentAliasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes an Alias for a Amazon Bedrock Agent

" + }, + "GetAgentKnowledgeBase":{ + "name":"GetAgentKnowledgeBase", + "http":{ + "method":"GET", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/", + "responseCode":200 + }, + "input":{"shape":"GetAgentKnowledgeBaseRequest"}, + "output":{"shape":"GetAgentKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets a knowledge base associated to an existing Amazon Bedrock Agent Version

" + }, + "GetAgentVersion":{ + "name":"GetAgentVersion", + "http":{ + "method":"GET", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/", + "responseCode":200 + }, + "input":{"shape":"GetAgentVersionRequest"}, + "output":{"shape":"GetAgentVersionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets an Agent version for existing Amazon Bedrock Agent

" + }, + "GetDataSource":{ + "name":"GetDataSource", + "http":{ + "method":"GET", + "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}", + "responseCode":200 + }, + "input":{"shape":"GetDataSourceRequest"}, + "output":{"shape":"GetDataSourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Get an existing data source

" + }, + "GetIngestionJob":{ + "name":"GetIngestionJob", + "http":{ + "method":"GET", + "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}", + "responseCode":200 + }, + "input":{"shape":"GetIngestionJobRequest"}, + "output":{"shape":"GetIngestionJobResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Get an ingestion job

" + }, + "GetKnowledgeBase":{ + "name":"GetKnowledgeBase", + "http":{ + "method":"GET", + "requestUri":"/knowledgebases/{knowledgeBaseId}", + "responseCode":200 + }, + "input":{"shape":"GetKnowledgeBaseRequest"}, + "output":{"shape":"GetKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Get an existing knowledge base

" + }, + "ListAgentActionGroups":{ + "name":"ListAgentActionGroups", + "http":{ + "method":"POST", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/actiongroups/", + "responseCode":200 + }, + "input":{"shape":"ListAgentActionGroupsRequest"}, + "output":{"shape":"ListAgentActionGroupsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists an Action Group for existing Amazon Bedrock Agent Version

" + }, + "ListAgentAliases":{ + "name":"ListAgentAliases", + "http":{ + "method":"POST", + "requestUri":"/agents/{agentId}/agentaliases/", + "responseCode":200 + }, + "input":{"shape":"ListAgentAliasesRequest"}, + "output":{"shape":"ListAgentAliasesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists all the Aliases for an Amazon Bedrock Agent

" + }, + "ListAgentKnowledgeBases":{ + "name":"ListAgentKnowledgeBases", + "http":{ + "method":"POST", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/", + "responseCode":200 + }, + "input":{"shape":"ListAgentKnowledgeBasesRequest"}, + "output":{"shape":"ListAgentKnowledgeBasesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version

" + }, + "ListAgentVersions":{ + "name":"ListAgentVersions", + "http":{ + "method":"POST", + "requestUri":"/agents/{agentId}/agentversions/", + "responseCode":200 + }, + "input":{"shape":"ListAgentVersionsRequest"}, + "output":{"shape":"ListAgentVersionsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists Agent Versions

" + }, + "ListAgents":{ + "name":"ListAgents", + "http":{ + "method":"POST", + "requestUri":"/agents/", + "responseCode":200 + }, + "input":{"shape":"ListAgentsRequest"}, + "output":{"shape":"ListAgentsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Lists Agents

" + }, + "ListDataSources":{ + "name":"ListDataSources", + "http":{ + "method":"POST", + "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/", + "responseCode":200 + }, + "input":{"shape":"ListDataSourcesRequest"}, + "output":{"shape":"ListDataSourcesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

List data sources

" + }, + "ListIngestionJobs":{ + "name":"ListIngestionJobs", + "http":{ + "method":"POST", + "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/", + "responseCode":200 + }, + "input":{"shape":"ListIngestionJobsRequest"}, + "output":{"shape":"ListIngestionJobsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

List ingestion jobs

" + }, + "ListKnowledgeBases":{ + "name":"ListKnowledgeBases", + "http":{ + "method":"POST", + "requestUri":"/knowledgebases/", + "responseCode":200 + }, + "input":{"shape":"ListKnowledgeBasesRequest"}, + "output":{"shape":"ListKnowledgeBasesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

List Knowledge Bases

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

List tags for a resource

" + }, + "PrepareAgent":{ + "name":"PrepareAgent", + "http":{ + "method":"POST", + "requestUri":"/agents/{agentId}/", + "responseCode":202 + }, + "input":{"shape":"PrepareAgentRequest"}, + "output":{"shape":"PrepareAgentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Prepares an existing Amazon Bedrock Agent to receive runtime requests

" + }, + "StartIngestionJob":{ + "name":"StartIngestionJob", + "http":{ + "method":"PUT", + "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/", + "responseCode":202 + }, + "input":{"shape":"StartIngestionJobRequest"}, + "output":{"shape":"StartIngestionJobResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Start a new ingestion job

", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Tag a resource

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Untag a resource

", + "idempotent":true + }, + "UpdateAgent":{ + "name":"UpdateAgent", + "http":{ + "method":"PUT", + "requestUri":"/agents/{agentId}/", + "responseCode":202 + }, + "input":{"shape":"UpdateAgentRequest"}, + "output":{"shape":"UpdateAgentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Updates an existing Amazon Bedrock Agent

", + "idempotent":true + }, + "UpdateAgentActionGroup":{ + "name":"UpdateAgentActionGroup", + "http":{ + "method":"PUT", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/", + "responseCode":200 + }, + "input":{"shape":"UpdateAgentActionGroupRequest"}, + "output":{"shape":"UpdateAgentActionGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Updates an existing Action Group for Amazon Bedrock Agent

", + "idempotent":true + }, + "UpdateAgentAlias":{ + "name":"UpdateAgentAlias", + "http":{ + "method":"PUT", + "requestUri":"/agents/{agentId}/agentaliases/{agentAliasId}/", + "responseCode":202 + }, + "input":{"shape":"UpdateAgentAliasRequest"}, + "output":{"shape":"UpdateAgentAliasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Updates an existing Alias for an Amazon Bedrock Agent

", + "idempotent":true + }, + "UpdateAgentKnowledgeBase":{ + "name":"UpdateAgentKnowledgeBase", + "http":{ + "method":"PUT", + "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/", + "responseCode":200 + }, + "input":{"shape":"UpdateAgentKnowledgeBaseRequest"}, + "output":{"shape":"UpdateAgentKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Updates an existing Knowledge Base associated to an Amazon Bedrock Agent

", + "idempotent":true + }, + "UpdateDataSource":{ + "name":"UpdateDataSource", + "http":{ + "method":"PUT", + "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}", + "responseCode":200 + }, + "input":{"shape":"UpdateDataSourceRequest"}, + "output":{"shape":"UpdateDataSourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Update an existing data source

", + "idempotent":true + }, + "UpdateKnowledgeBase":{ + "name":"UpdateKnowledgeBase", + "http":{ + "method":"PUT", + "requestUri":"/knowledgebases/{knowledgeBaseId}", + "responseCode":202 + }, + "input":{"shape":"UpdateKnowledgeBaseRequest"}, + "output":{"shape":"UpdateKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Update an existing knowledge base

", + "idempotent":true + } + }, + "shapes":{ + "APISchema":{ + "type":"structure", + "members":{ + "s3":{"shape":"S3Identifier"}, + "payload":{"shape":"Payload"} + }, + "documentation":"

Contains information about the API Schema for the Action Group

", + "union":true + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when a request is denied per access permissions

", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ActionGroupExecutor":{ + "type":"structure", + "members":{ + "lambda":{"shape":"LambdaArn"} + }, + "documentation":"

Type of Executors for an Action Group

", + "union":true + }, + "ActionGroupSignature":{ + "type":"string", + "documentation":"

Action Group Signature for a BuiltIn Action

", + "enum":["AMAZON.UserInput"] + }, + "ActionGroupState":{ + "type":"string", + "documentation":"

State of the action group

", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "ActionGroupSummaries":{ + "type":"list", + "member":{"shape":"ActionGroupSummary"}, + "documentation":"

List of ActionGroup Summaries

", + "max":10, + "min":0 + }, + "ActionGroupSummary":{ + "type":"structure", + "required":[ + "actionGroupId", + "actionGroupName", + "actionGroupState", + "updatedAt" + ], + "members":{ + "actionGroupId":{"shape":"Id"}, + "actionGroupName":{"shape":"Name"}, + "actionGroupState":{"shape":"ActionGroupState"}, + "description":{"shape":"Description"}, + "updatedAt":{"shape":"DateTimestamp"} + }, + "documentation":"

ActionGroup Summary

" + }, + "Agent":{ + "type":"structure", + "required":[ + "agentId", + "agentName", + "agentArn", + "agentVersion", + "agentStatus", + "idleSessionTTLInSeconds", + "agentResourceRoleArn", + "createdAt", + "updatedAt" + ], + "members":{ + "agentId":{"shape":"Id"}, + "agentName":{"shape":"Name"}, + "agentArn":{"shape":"AgentArn"}, + "agentVersion":{"shape":"DraftVersion"}, + "clientToken":{"shape":"ClientToken"}, + "instruction":{"shape":"Instruction"}, + "agentStatus":{"shape":"AgentStatus"}, + "foundationModel":{"shape":"ModelIdentifier"}, + "description":{"shape":"Description"}, + "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, + "agentResourceRoleArn":{"shape":"AgentRoleArn"}, + "customerEncryptionKeyArn":{"shape":"KmsKeyArn"}, + "createdAt":{"shape":"DateTimestamp"}, + "updatedAt":{"shape":"DateTimestamp"}, + "preparedAt":{"shape":"DateTimestamp"}, + "failureReasons":{"shape":"FailureReasons"}, + "recommendedActions":{"shape":"RecommendedActions"}, + "promptOverrideConfiguration":{"shape":"PromptOverrideConfiguration"} + }, + "documentation":"

Contains the information of an agent

" + }, + "AgentActionGroup":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "actionGroupId", + "actionGroupName", + "createdAt", + "updatedAt", + "actionGroupState" + ], + "members":{ + "agentId":{"shape":"Id"}, + "agentVersion":{"shape":"Version"}, + "actionGroupId":{"shape":"Id"}, + "actionGroupName":{"shape":"Name"}, + "clientToken":{"shape":"ClientToken"}, + "description":{"shape":"Description"}, + "createdAt":{"shape":"DateTimestamp"}, + "updatedAt":{"shape":"DateTimestamp"}, + "parentActionSignature":{"shape":"ActionGroupSignature"}, + "actionGroupExecutor":{"shape":"ActionGroupExecutor"}, + "apiSchema":{"shape":"APISchema"}, + "actionGroupState":{"shape":"ActionGroupState"} + }, + "documentation":"

Contains the information of an Agent Action Group

" + }, + "AgentAlias":{ + "type":"structure", + "required":[ + "agentId", + "agentAliasId", + "agentAliasName", + "agentAliasArn", + "routingConfiguration", + "createdAt", + "updatedAt", + "agentAliasStatus" + ], + "members":{ + "agentId":{"shape":"Id"}, + "agentAliasId":{"shape":"AgentAliasId"}, + "agentAliasName":{"shape":"Name"}, + "agentAliasArn":{"shape":"AgentAliasArn"}, + "clientToken":{"shape":"ClientToken"}, + "description":{"shape":"Description"}, + "routingConfiguration":{"shape":"AgentAliasRoutingConfiguration"}, + "createdAt":{"shape":"DateTimestamp"}, + "updatedAt":{"shape":"DateTimestamp"}, + "agentAliasHistoryEvents":{"shape":"AgentAliasHistoryEvents"}, + "agentAliasStatus":{"shape":"AgentAliasStatus"} + }, + "documentation":"

Contains the information of an agent alias

" + }, + "AgentAliasArn":{ + "type":"string", + "documentation":"

Arn representation of the Agent Alias.

", + "max":2048, + "min":0, + "pattern":"arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}" + }, + "AgentAliasHistoryEvent":{ + "type":"structure", + "members":{ + "routingConfiguration":{"shape":"AgentAliasRoutingConfiguration"}, + "endDate":{"shape":"DateTimestamp"}, + "startDate":{"shape":"DateTimestamp"} + }, + "documentation":"

History event for an alias for an Agent.

" + }, + "AgentAliasHistoryEvents":{ + "type":"list", + "member":{"shape":"AgentAliasHistoryEvent"}, + "documentation":"

The list of history events for an alias for an Agent.

", + "max":10, + "min":0 + }, + "AgentAliasId":{ + "type":"string", + "documentation":"

Id for an Agent Alias generated at the server side.

", + "max":10, + "min":10, + "pattern":"(\\bTSTALIASID\\b|[0-9a-zA-Z]+)" + }, + "AgentAliasRoutingConfiguration":{ + "type":"list", + "member":{"shape":"AgentAliasRoutingConfigurationListItem"}, + "documentation":"

Routing configuration for an Agent alias.

", + "max":1, + "min":0 + }, + "AgentAliasRoutingConfigurationListItem":{ + "type":"structure", + "required":["agentVersion"], + "members":{ + "agentVersion":{"shape":"Version"} + }, + "documentation":"

Details about the routing configuration for an Agent alias.

" + }, + "AgentAliasStatus":{ + "type":"string", + "documentation":"

The statuses an Agent Alias can be in.

", + "enum":[ + "CREATING", + "PREPARED", + "FAILED", + "UPDATING", + "DELETING" + ] + }, + "AgentAliasSummaries":{ + "type":"list", + "member":{"shape":"AgentAliasSummary"}, + "documentation":"

The list of summaries of all the aliases for an Agent.

", + "max":10, + "min":0 + }, + "AgentAliasSummary":{ + "type":"structure", + "required":[ + "agentAliasId", + "agentAliasName", + "agentAliasStatus", + "createdAt", + "updatedAt" + ], + "members":{ + "agentAliasId":{"shape":"AgentAliasId"}, + "agentAliasName":{"shape":"Name"}, + "description":{"shape":"Description"}, + "routingConfiguration":{"shape":"AgentAliasRoutingConfiguration"}, + "agentAliasStatus":{"shape":"AgentAliasStatus"}, + "createdAt":{"shape":"DateTimestamp"}, + "updatedAt":{"shape":"DateTimestamp"} + }, + "documentation":"

Summary of an alias for an Agent.

" + }, + "AgentArn":{ + "type":"string", + "documentation":"

Arn representation of the Agent.

", + "max":2048, + "min":0, + "pattern":"arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}" + }, + "AgentKnowledgeBase":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "knowledgeBaseId", + "description", + "createdAt", + "updatedAt", + "knowledgeBaseState" + ], + "members":{ + "agentId":{"shape":"Id"}, + "agentVersion":{"shape":"Version"}, + "knowledgeBaseId":{"shape":"Id"}, + "description":{"shape":"Description"}, + "createdAt":{"shape":"DateTimestamp"}, + "updatedAt":{"shape":"DateTimestamp"}, + "knowledgeBaseState":{"shape":"KnowledgeBaseState"} + }, + "documentation":"

Contains the information of an Agent Knowledge Base.

" + }, + "AgentKnowledgeBaseSummaries":{ + "type":"list", + "member":{"shape":"AgentKnowledgeBaseSummary"}, + "documentation":"

List of Agent Knowledge Base Summaries

", + "max":10, + "min":0 + }, + "AgentKnowledgeBaseSummary":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "knowledgeBaseState", + "updatedAt" + ], + "members":{ + "knowledgeBaseId":{"shape":"Id"}, + "description":{"shape":"Description"}, + "knowledgeBaseState":{"shape":"KnowledgeBaseState"}, + "updatedAt":{"shape":"DateTimestamp"} + }, + "documentation":"

Agent Knowledge Base Summary

" + }, + "AgentRoleArn":{ + "type":"string", + "documentation":"

ARN of a IAM role.

", + "max":2048, + "min":0, + "pattern":"arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents.+" + }, + "AgentStatus":{ + "type":"string", + "documentation":"

Schema Type for Action APIs.

", + "enum":[ + "CREATING", + "PREPARING", + "PREPARED", + "NOT_PREPARED", + "DELETING", + "FAILED", + "VERSIONING", + "UPDATING" + ] + }, + "AgentSummaries":{ + "type":"list", + "member":{"shape":"AgentSummary"}, + "documentation":"

List of AgentSummary.

", + "max":10, + "min":0 + }, + "AgentSummary":{ + "type":"structure", + "required":[ + "agentId", + "agentName", + "agentStatus", + "updatedAt" + ], + "members":{ + "agentId":{"shape":"Id"}, + "agentName":{"shape":"Name"}, + "agentStatus":{"shape":"AgentStatus"}, + "description":{"shape":"Description"}, + "updatedAt":{"shape":"DateTimestamp"}, + "latestAgentVersion":{"shape":"Version"} + }, + "documentation":"

Summary of Agent.

" + }, + "AgentVersion":{ + "type":"structure", + "required":[ + "agentId", + "agentName", + "agentArn", + "version", + "agentStatus", + "idleSessionTTLInSeconds", + "agentResourceRoleArn", + "createdAt", + "updatedAt" + ], + "members":{ + "agentId":{"shape":"Id"}, + "agentName":{"shape":"Name"}, + "agentArn":{"shape":"AgentArn"}, + "version":{"shape":"NumericalVersion"}, + "instruction":{"shape":"Instruction"}, + "agentStatus":{"shape":"AgentStatus"}, + "foundationModel":{"shape":"ModelIdentifier"}, + "description":{"shape":"Description"}, + "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, + "agentResourceRoleArn":{"shape":"AgentRoleArn"}, + "customerEncryptionKeyArn":{"shape":"KmsKeyArn"}, + "createdAt":{"shape":"DateTimestamp"}, + "updatedAt":{"shape":"DateTimestamp"}, + "failureReasons":{"shape":"FailureReasons"}, + "recommendedActions":{"shape":"RecommendedActions"}, + "promptOverrideConfiguration":{"shape":"PromptOverrideConfiguration"} + }, + "documentation":"

Contains the information of an agent version.

" + }, + "AgentVersionSummaries":{ + "type":"list", + "member":{"shape":"AgentVersionSummary"}, + "documentation":"

List of AgentVersionSummary.

", + "max":10, + "min":0 + }, + "AgentVersionSummary":{ + "type":"structure", + "required":[ + "agentName", + "agentStatus", + "agentVersion", + "createdAt", + "updatedAt" + ], + "members":{ + "agentName":{"shape":"Name"}, + "agentStatus":{"shape":"AgentStatus"}, + "agentVersion":{"shape":"Version"}, + "createdAt":{"shape":"DateTimestamp"}, + "updatedAt":{"shape":"DateTimestamp"}, + "description":{"shape":"Description"} + }, + "documentation":"

Summary of agent version.

" + }, + "AssociateAgentKnowledgeBaseRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "knowledgeBaseId", + "description" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"DraftVersion", + "documentation":"

Draft Version of the Agent.

", + "location":"uri", + "locationName":"agentVersion" + }, + "knowledgeBaseId":{"shape":"Id"}, + "description":{"shape":"Description"}, + "knowledgeBaseState":{"shape":"KnowledgeBaseState"} + }, + "documentation":"

Associate Agent Knowledge Base Request

" + }, + "AssociateAgentKnowledgeBaseResponse":{ + "type":"structure", + "required":["agentKnowledgeBase"], + "members":{ + "agentKnowledgeBase":{"shape":"AgentKnowledgeBase"} + }, + "documentation":"

Associate Agent Knowledge Base Response

" + }, + "BasePromptTemplate":{ + "type":"string", + "documentation":"

Base Prompt Template.

", + "max":100000, + "min":1 + }, + "BedrockEmbeddingModelArn":{ + "type":"string", + "documentation":"

Arn of a Bedrock model.

", + "max":1011, + "min":20, + "pattern":"arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))" + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ChunkingConfiguration":{ + "type":"structure", + "required":["chunkingStrategy"], + "members":{ + "chunkingStrategy":{"shape":"ChunkingStrategy"}, + "fixedSizeChunkingConfiguration":{"shape":"FixedSizeChunkingConfiguration"} + }, + "documentation":"

Configures chunking strategy

" + }, + "ChunkingStrategy":{ + "type":"string", + "documentation":"

The type of chunking strategy

", + "enum":[ + "FIXED_SIZE", + "NONE" + ] + }, + "ClientToken":{ + "type":"string", + "documentation":"

Client specified token used for idempotency checks

", + "max":256, + "min":33, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when there is a conflict performing an operation

", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateAgentActionGroupRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "actionGroupName" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"DraftVersion", + "documentation":"

Draft Version of the Agent.

", + "location":"uri", + "locationName":"agentVersion" + }, + "actionGroupName":{"shape":"Name"}, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "description":{"shape":"Description"}, + "parentActionGroupSignature":{"shape":"ActionGroupSignature"}, + "actionGroupExecutor":{"shape":"ActionGroupExecutor"}, + "apiSchema":{"shape":"APISchema"}, + "actionGroupState":{"shape":"ActionGroupState"} + }, + "documentation":"

Create Action Group Request

" + }, + "CreateAgentActionGroupResponse":{ + "type":"structure", + "required":["agentActionGroup"], + "members":{ + "agentActionGroup":{"shape":"AgentActionGroup"} + }, + "documentation":"

Create Action Group Response

" + }, + "CreateAgentAliasRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentAliasName" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentAliasName":{"shape":"Name"}, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "description":{"shape":"Description"}, + "routingConfiguration":{"shape":"AgentAliasRoutingConfiguration"}, + "tags":{"shape":"TagsMap"} + }, + "documentation":"

Create Agent Alias Request

" + }, + "CreateAgentAliasResponse":{ + "type":"structure", + "required":["agentAlias"], + "members":{ + "agentAlias":{"shape":"AgentAlias"} + }, + "documentation":"

Create Agent Alias Response

" + }, + "CreateAgentRequest":{ + "type":"structure", + "required":[ + "agentName", + "agentResourceRoleArn" + ], + "members":{ + "agentName":{"shape":"Name"}, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "instruction":{"shape":"Instruction"}, + "foundationModel":{"shape":"ModelIdentifier"}, + "description":{"shape":"Description"}, + "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, + "agentResourceRoleArn":{"shape":"AgentRoleArn"}, + "customerEncryptionKeyArn":{"shape":"KmsKeyArn"}, + "tags":{"shape":"TagsMap"}, + "promptOverrideConfiguration":{"shape":"PromptOverrideConfiguration"} + }, + "documentation":"

Create Agent Request

" + }, + "CreateAgentResponse":{ + "type":"structure", + "required":["agent"], + "members":{ + "agent":{"shape":"Agent"} + }, + "documentation":"

Create Agent Response

" + }, + "CreateDataSourceRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "name", + "dataSourceConfiguration" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "name":{"shape":"Name"}, + "description":{"shape":"Description"}, + "dataSourceConfiguration":{"shape":"DataSourceConfiguration"}, + "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "vectorIngestionConfiguration":{"shape":"VectorIngestionConfiguration"} + } + }, + "CreateDataSourceResponse":{ + "type":"structure", + "required":["dataSource"], + "members":{ + "dataSource":{"shape":"DataSource"} + } + }, + "CreateKnowledgeBaseRequest":{ + "type":"structure", + "required":[ + "name", + "roleArn", + "knowledgeBaseConfiguration", + "storageConfiguration" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "name":{"shape":"Name"}, + "description":{"shape":"Description"}, + "roleArn":{"shape":"KnowledgeBaseRoleArn"}, + "knowledgeBaseConfiguration":{"shape":"KnowledgeBaseConfiguration"}, + "storageConfiguration":{"shape":"StorageConfiguration"}, + "tags":{"shape":"TagsMap"} + } + }, + "CreateKnowledgeBaseResponse":{ + "type":"structure", + "required":["knowledgeBase"], + "members":{ + "knowledgeBase":{"shape":"KnowledgeBase"} + } + }, + "CreationMode":{ + "type":"string", + "documentation":"

Creation Mode for Prompt Configuration.

", + "enum":[ + "DEFAULT", + "OVERRIDDEN" + ] + }, + "DataSource":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "dataSourceId", + "name", + "status", + "dataSourceConfiguration", + "createdAt", + "updatedAt" + ], + "members":{ + "knowledgeBaseId":{"shape":"Id"}, + "dataSourceId":{"shape":"Id"}, + "name":{"shape":"Name"}, + "status":{"shape":"DataSourceStatus"}, + "description":{"shape":"Description"}, + "dataSourceConfiguration":{"shape":"DataSourceConfiguration"}, + "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "vectorIngestionConfiguration":{"shape":"VectorIngestionConfiguration"}, + "createdAt":{"shape":"DateTimestamp"}, + "updatedAt":{"shape":"DateTimestamp"} + }, + "documentation":"

Contains the information of a data source.

" + }, + "DataSourceConfiguration":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{"shape":"DataSourceType"}, + "s3Configuration":{"shape":"S3DataSourceConfiguration"} + }, + "documentation":"

Specifies a raw data source location to ingest.

" + }, + "DataSourceStatus":{ + "type":"string", + "documentation":"

The status of a data source.

", + "enum":[ + "AVAILABLE", + "DELETING" + ] + }, + "DataSourceSummaries":{ + "type":"list", + "member":{"shape":"DataSourceSummary"}, + "documentation":"

list of data source summaries

" + }, + "DataSourceSummary":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "dataSourceId", + "name", + "status", + "updatedAt" + ], + "members":{ + "knowledgeBaseId":{"shape":"Id"}, + "dataSourceId":{"shape":"Id"}, + "name":{"shape":"Name"}, + "status":{"shape":"DataSourceStatus"}, + "description":{"shape":"Description"}, + "updatedAt":{"shape":"DateTimestamp"} + }, + "documentation":"

Summary information of a data source.

" + }, + "DataSourceType":{ + "type":"string", + "documentation":"

The type of the data source location.

", + "enum":["S3"] + }, + "DateTimestamp":{ + "type":"timestamp", + "documentation":"

Time Stamp.

", + "timestampFormat":"iso8601" + }, + "DeleteAgentActionGroupRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "actionGroupId" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"DraftVersion", + "documentation":"

Draft Version of the Agent.

", + "location":"uri", + "locationName":"agentVersion" + }, + "actionGroupId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent ActionGroup is created

", + "location":"uri", + "locationName":"actionGroupId" + }, + "skipResourceInUseCheck":{ + "shape":"Boolean", + "documentation":"

Skips checking if resource is in use when set to true. Defaults to false

", + "location":"querystring", + "locationName":"skipResourceInUseCheck" + } + }, + "documentation":"

Delete Action Group Request

" + }, + "DeleteAgentActionGroupResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Delete Action Group Response

" + }, + "DeleteAgentAliasRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentAliasId" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"

Id generated at the server side when an Agent Alias is created

", + "location":"uri", + "locationName":"agentAliasId" + } + }, + "documentation":"

Delete Agent Alias Request

" + }, + "DeleteAgentAliasResponse":{ + "type":"structure", + "required":[ + "agentId", + "agentAliasId", + "agentAliasStatus" + ], + "members":{ + "agentId":{"shape":"Id"}, + "agentAliasId":{"shape":"AgentAliasId"}, + "agentAliasStatus":{"shape":"AgentAliasStatus"} + }, + "documentation":"

Delete Agent Alias Response

" + }, + "DeleteAgentRequest":{ + "type":"structure", + "required":["agentId"], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "skipResourceInUseCheck":{ + "shape":"Boolean", + "documentation":"

Skips checking if resource is in use when set to true. Defaults to false

", + "location":"querystring", + "locationName":"skipResourceInUseCheck" + } + }, + "documentation":"

Delete Agent Request

" + }, + "DeleteAgentResponse":{ + "type":"structure", + "required":[ + "agentId", + "agentStatus" + ], + "members":{ + "agentId":{"shape":"Id"}, + "agentStatus":{"shape":"AgentStatus"} + }, + "documentation":"

Delete Agent Response

" + }, + "DeleteAgentVersionRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"NumericalVersion", + "location":"uri", + "locationName":"agentVersion" + }, + "skipResourceInUseCheck":{ + "shape":"Boolean", + "documentation":"

Skips checking if resource is in use when set to true. Defaults to false

", + "location":"querystring", + "locationName":"skipResourceInUseCheck" + } + }, + "documentation":"

Delete Agent Version Request

" + }, + "DeleteAgentVersionResponse":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "agentStatus" + ], + "members":{ + "agentId":{"shape":"Id"}, + "agentVersion":{"shape":"NumericalVersion"}, + "agentStatus":{"shape":"AgentStatus"} + }, + "documentation":"

Delete Agent Version Response

" + }, + "DeleteDataSourceRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "dataSourceId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "dataSourceId":{ + "shape":"Id", + "location":"uri", + "locationName":"dataSourceId" + } + } + }, + "DeleteDataSourceResponse":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "dataSourceId", + "status" + ], + "members":{ + "knowledgeBaseId":{"shape":"Id"}, + "dataSourceId":{"shape":"Id"}, + "status":{"shape":"DataSourceStatus"} + } + }, + "DeleteKnowledgeBaseRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DeleteKnowledgeBaseResponse":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "status" + ], + "members":{ + "knowledgeBaseId":{"shape":"Id"}, + "status":{"shape":"KnowledgeBaseStatus"} + } + }, + "Description":{ + "type":"string", + "documentation":"

Description of the Resource.

", + "max":200, + "min":1 + }, + "DisassociateAgentKnowledgeBaseRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "knowledgeBaseId" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"DraftVersion", + "documentation":"

Draft Version of the Agent.

", + "location":"uri", + "locationName":"agentVersion" + }, + "knowledgeBaseId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when a Knowledge Base is associated to an Agent

", + "location":"uri", + "locationName":"knowledgeBaseId" + } + }, + "documentation":"

Disassociate Agent Knowledge Base Request

" + }, + "DisassociateAgentKnowledgeBaseResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Disassociate Agent Knowledge Base Response

" + }, + "DraftVersion":{ + "type":"string", + "documentation":"

Draft Agent Version.

", + "max":5, + "min":5, + "pattern":"DRAFT" + }, + "FailureReason":{ + "type":"string", + "documentation":"

Failure Reason for Error.

", + "max":2048, + "min":0 + }, + "FailureReasons":{ + "type":"list", + "member":{"shape":"FailureReason"}, + "documentation":"

Failure Reasons for Error.

", + "max":2048, + "min":0 + }, + "FieldName":{ + "type":"string", + "documentation":"

Name of the field

", + "max":2048, + "min":0, + "pattern":".*" + }, + "FixedSizeChunkingConfiguration":{ + "type":"structure", + "required":[ + "maxTokens", + "overlapPercentage" + ], + "members":{ + "maxTokens":{ + "shape":"FixedSizeChunkingConfigurationMaxTokensInteger", + "documentation":"

The maximum number of tokens per chunk.

" + }, + "overlapPercentage":{ + "shape":"FixedSizeChunkingConfigurationOverlapPercentageInteger", + "documentation":"

The overlap percentage between adjacent chunks.

" + } + }, + "documentation":"

Configures fixed size chunking strategy

" + }, + "FixedSizeChunkingConfigurationMaxTokensInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "FixedSizeChunkingConfigurationOverlapPercentageInteger":{ + "type":"integer", + "box":true, + "max":99, + "min":1 + }, + "GetAgentActionGroupRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "actionGroupId" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"Version", + "documentation":"

Version number generated when a version is created

", + "location":"uri", + "locationName":"agentVersion" + }, + "actionGroupId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent Action Group is created

", + "location":"uri", + "locationName":"actionGroupId" + } + }, + "documentation":"

Get Action Group Request

" + }, + "GetAgentActionGroupResponse":{ + "type":"structure", + "required":["agentActionGroup"], + "members":{ + "agentActionGroup":{"shape":"AgentActionGroup"} + }, + "documentation":"

Get Action Group Response

" + }, + "GetAgentAliasRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentAliasId" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"

Id generated at the server side when an Agent Alias is created

", + "location":"uri", + "locationName":"agentAliasId" + } + }, + "documentation":"

Get Agent Alias Request

" + }, + "GetAgentAliasResponse":{ + "type":"structure", + "required":["agentAlias"], + "members":{ + "agentAlias":{"shape":"AgentAlias"} + }, + "documentation":"

Get Agent Alias Response

" + }, + "GetAgentKnowledgeBaseRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "knowledgeBaseId" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"Version", + "documentation":"

Version number generated when a version is created

", + "location":"uri", + "locationName":"agentVersion" + }, + "knowledgeBaseId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when a Knowledge Base is associated

", + "location":"uri", + "locationName":"knowledgeBaseId" + } + }, + "documentation":"

Get Agent Knowledge Base Request

" + }, + "GetAgentKnowledgeBaseResponse":{ + "type":"structure", + "required":["agentKnowledgeBase"], + "members":{ + "agentKnowledgeBase":{"shape":"AgentKnowledgeBase"} + }, + "documentation":"

Get Agent Knowledge Base Response

" + }, + "GetAgentRequest":{ + "type":"structure", + "required":["agentId"], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + } + }, + "documentation":"

Get Agent Request

" + }, + "GetAgentResponse":{ + "type":"structure", + "required":["agent"], + "members":{ + "agent":{"shape":"Agent"} + }, + "documentation":"

Get Agent Response

" + }, + "GetAgentVersionRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"NumericalVersion", + "location":"uri", + "locationName":"agentVersion" + } + }, + "documentation":"

Get Agent Version Request

" + }, + "GetAgentVersionResponse":{ + "type":"structure", + "required":["agentVersion"], + "members":{ + "agentVersion":{"shape":"AgentVersion"} + }, + "documentation":"

Get Agent Version Response

" + }, + "GetDataSourceRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "dataSourceId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "dataSourceId":{ + "shape":"Id", + "location":"uri", + "locationName":"dataSourceId" + } + } + }, + "GetDataSourceResponse":{ + "type":"structure", + "required":["dataSource"], + "members":{ + "dataSource":{"shape":"DataSource"} + } + }, + "GetIngestionJobRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "dataSourceId", + "ingestionJobId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "dataSourceId":{ + "shape":"Id", + "location":"uri", + "locationName":"dataSourceId" + }, + "ingestionJobId":{ + "shape":"Id", + "location":"uri", + "locationName":"ingestionJobId" + } + } + }, + "GetIngestionJobResponse":{ + "type":"structure", + "required":["ingestionJob"], + "members":{ + "ingestionJob":{"shape":"IngestionJob"} + } + }, + "GetKnowledgeBaseRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetKnowledgeBaseResponse":{ + "type":"structure", + "required":["knowledgeBase"], + "members":{ + "knowledgeBase":{"shape":"KnowledgeBase"} + } + }, + "Id":{ + "type":"string", + "documentation":"

Identifier for a resource.

", + "pattern":"[0-9a-zA-Z]{10}" + }, + "InferenceConfiguration":{ + "type":"structure", + "members":{ + "temperature":{"shape":"Temperature"}, + "topP":{"shape":"TopP"}, + "topK":{"shape":"TopK"}, + "maximumLength":{"shape":"MaximumLength"}, + "stopSequences":{"shape":"StopSequences"} + }, + "documentation":"

Configuration for inference in prompt configuration

" + }, + "IngestionJob":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "dataSourceId", + "ingestionJobId", + "status", + "startedAt", + "updatedAt" + ], + "members":{ + "knowledgeBaseId":{"shape":"Id"}, + "dataSourceId":{"shape":"Id"}, + "ingestionJobId":{"shape":"Id"}, + "description":{"shape":"Description"}, + "status":{"shape":"IngestionJobStatus"}, + "statistics":{"shape":"IngestionJobStatistics"}, + "failureReasons":{"shape":"FailureReasons"}, + "startedAt":{"shape":"DateTimestamp"}, + "updatedAt":{"shape":"DateTimestamp"} + }, + "documentation":"

Contains the information of an ingestion job.

" + }, + "IngestionJobFilter":{ + "type":"structure", + "required":[ + "attribute", + "operator", + "values" + ], + "members":{ + "attribute":{"shape":"IngestionJobFilterAttribute"}, + "operator":{"shape":"IngestionJobFilterOperator"}, + "values":{"shape":"IngestionJobFilterValues"} + }, + "documentation":"

Filters the response returned by ListIngestionJobs operation.

" + }, + "IngestionJobFilterAttribute":{ + "type":"string", + "documentation":"

The name of the field to filter ingestion jobs.

", + "enum":["STATUS"] + }, + "IngestionJobFilterOperator":{ + "type":"string", + "documentation":"

The operator used to filter ingestion jobs.

", + "enum":["EQ"] + }, + "IngestionJobFilterValue":{ + "type":"string", + "documentation":"

The value used to filter ingestion jobs.

", + "max":100, + "min":0, + "pattern":".*" + }, + "IngestionJobFilterValues":{ + "type":"list", + "member":{"shape":"IngestionJobFilterValue"}, + "documentation":"

The list of values used to filter ingestion jobs.

", + "max":10, + "min":0 + }, + "IngestionJobFilters":{ + "type":"list", + "member":{"shape":"IngestionJobFilter"}, + "documentation":"

List of IngestionJobFilters

", + "max":1, + "min":1 + }, + "IngestionJobSortBy":{ + "type":"structure", + "required":[ + "attribute", + "order" + ], + "members":{ + "attribute":{"shape":"IngestionJobSortByAttribute"}, + "order":{"shape":"SortOrder"} + }, + "documentation":"

Sorts the response returned by ListIngestionJobs operation.

" + }, + "IngestionJobSortByAttribute":{ + "type":"string", + "documentation":"

The name of the field to sort ingestion jobs.

", + "enum":[ + "STATUS", + "STARTED_AT" + ] + }, + "IngestionJobStatistics":{ + "type":"structure", + "members":{ + "numberOfDocumentsScanned":{ + "shape":"PrimitiveLong", + "documentation":"

Number of scanned documents

" + }, + "numberOfNewDocumentsIndexed":{ + "shape":"PrimitiveLong", + "documentation":"

Number of indexed documents

" + }, + "numberOfModifiedDocumentsIndexed":{ + "shape":"PrimitiveLong", + "documentation":"

Number of modified documents indexed

" + }, + "numberOfDocumentsDeleted":{ + "shape":"PrimitiveLong", + "documentation":"

Number of deleted documents

" + }, + "numberOfDocumentsFailed":{ + "shape":"PrimitiveLong", + "documentation":"

Number of failed documents

" + } + }, + "documentation":"

The document level statistics of an ingestion job

" + }, + "IngestionJobStatus":{ + "type":"string", + "documentation":"

The status of an ingestion job.

", + "enum":[ + "STARTING", + "IN_PROGRESS", + "COMPLETE", + "FAILED" + ] + }, + "IngestionJobSummaries":{ + "type":"list", + "member":{"shape":"IngestionJobSummary"}, + "documentation":"

List of IngestionJobSummaries

" + }, + "IngestionJobSummary":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "dataSourceId", + "ingestionJobId", + "status", + "startedAt", + "updatedAt" + ], + "members":{ + "knowledgeBaseId":{"shape":"Id"}, + "dataSourceId":{"shape":"Id"}, + "ingestionJobId":{"shape":"Id"}, + "description":{"shape":"Description"}, + "status":{"shape":"IngestionJobStatus"}, + "startedAt":{"shape":"DateTimestamp"}, + "updatedAt":{"shape":"DateTimestamp"}, + "statistics":{"shape":"IngestionJobStatistics"} + }, + "documentation":"

Summary information of an ingestion job.

" + }, + "Instruction":{ + "type":"string", + "documentation":"

Instruction for the agent.

", + "max":1200, + "min":40, + "sensitive":true + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown if there was an unexpected error during processing of request

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "KmsKeyArn":{ + "type":"string", + "documentation":"

A KMS key ARN

", + "max":2048, + "min":1, + "pattern":"arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}" + }, + "KnowledgeBase":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "name", + "knowledgeBaseArn", + "roleArn", + "knowledgeBaseConfiguration", + "storageConfiguration", + "status", + "createdAt", + "updatedAt" + ], + "members":{ + "knowledgeBaseId":{"shape":"Id"}, + "name":{"shape":"Name"}, + "knowledgeBaseArn":{"shape":"KnowledgeBaseArn"}, + "description":{"shape":"Description"}, + "roleArn":{"shape":"KnowledgeBaseRoleArn"}, + "knowledgeBaseConfiguration":{"shape":"KnowledgeBaseConfiguration"}, + "storageConfiguration":{"shape":"StorageConfiguration"}, + "status":{"shape":"KnowledgeBaseStatus"}, + "createdAt":{"shape":"DateTimestamp"}, + "updatedAt":{"shape":"DateTimestamp"}, + "failureReasons":{"shape":"FailureReasons"} + }, + "documentation":"

Contains the information of a knowledge base.

" + }, + "KnowledgeBaseArn":{ + "type":"string", + "documentation":"

ARN of a KnowledgeBase

", + "max":128, + "min":0, + "pattern":"arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+" + }, + "KnowledgeBaseConfiguration":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{"shape":"KnowledgeBaseType"}, + "vectorKnowledgeBaseConfiguration":{"shape":"VectorKnowledgeBaseConfiguration"} + }, + "documentation":"

Configures a bedrock knowledge base.

" + }, + "KnowledgeBaseRoleArn":{ + "type":"string", + "documentation":"

ARN of a IAM role.

", + "max":2048, + "min":0, + "pattern":"arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForKnowledgeBase.+" + }, + "KnowledgeBaseState":{ + "type":"string", + "documentation":"

State of the knowledge base; whether it is enabled or disabled

", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "KnowledgeBaseStatus":{ + "type":"string", + "documentation":"

The status of a knowledge base.

", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "UPDATING", + "FAILED" + ] + }, + "KnowledgeBaseStorageType":{ + "type":"string", + "documentation":"

The storage type of a knowledge base.

", + "enum":[ + "OPENSEARCH_SERVERLESS", + "PINECONE", + "REDIS_ENTERPRISE_CLOUD" + ] + }, + "KnowledgeBaseSummaries":{ + "type":"list", + "member":{"shape":"KnowledgeBaseSummary"}, + "documentation":"

List of KnowledgeBaseSummaries

" + }, + "KnowledgeBaseSummary":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "name", + "status", + "updatedAt" + ], + "members":{ + "knowledgeBaseId":{"shape":"Id"}, + "name":{"shape":"Name"}, + "description":{"shape":"Description"}, + "status":{"shape":"KnowledgeBaseStatus"}, + "updatedAt":{"shape":"DateTimestamp"} + }, + "documentation":"

Summary information of a knowledge base.

" + }, + "KnowledgeBaseType":{ + "type":"string", + "documentation":"

The type of a knowledge base.

", + "enum":["VECTOR"] + }, + "LambdaArn":{ + "type":"string", + "documentation":"

ARN of a Lambda.

", + "max":2048, + "min":0, + "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + }, + "ListAgentActionGroupsRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is Listed

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"Version", + "documentation":"

Id generated at the server side when an Agent is Listed

", + "location":"uri", + "locationName":"agentVersion" + }, + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"} + }, + "documentation":"

List Action Groups Request

" + }, + "ListAgentActionGroupsResponse":{ + "type":"structure", + "required":["actionGroupSummaries"], + "members":{ + "actionGroupSummaries":{"shape":"ActionGroupSummaries"}, + "nextToken":{"shape":"NextToken"} + }, + "documentation":"

List Action Groups Response

" + }, + "ListAgentAliasesRequest":{ + "type":"structure", + "required":["agentId"], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"} + }, + "documentation":"

List Agent Aliases Request

" + }, + "ListAgentAliasesResponse":{ + "type":"structure", + "required":["agentAliasSummaries"], + "members":{ + "agentAliasSummaries":{"shape":"AgentAliasSummaries"}, + "nextToken":{"shape":"NextToken"} + }, + "documentation":"

List Agent Aliases Response

" + }, + "ListAgentKnowledgeBasesRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"Version", + "documentation":"

Version number generated when a version is created

", + "location":"uri", + "locationName":"agentVersion" + }, + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"} + }, + "documentation":"

List Agent Knowledge Bases Request

" + }, + "ListAgentKnowledgeBasesResponse":{ + "type":"structure", + "required":["agentKnowledgeBaseSummaries"], + "members":{ + "agentKnowledgeBaseSummaries":{"shape":"AgentKnowledgeBaseSummaries"}, + "nextToken":{"shape":"NextToken"} + }, + "documentation":"

List Agent Knowledge Bases Response

" + }, + "ListAgentVersionsRequest":{ + "type":"structure", + "required":["agentId"], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"} + }, + "documentation":"

List Agent Versions Request

" + }, + "ListAgentVersionsResponse":{ + "type":"structure", + "required":["agentVersionSummaries"], + "members":{ + "agentVersionSummaries":{"shape":"AgentVersionSummaries"}, + "nextToken":{"shape":"NextToken"} + }, + "documentation":"

List Agent Versions Response

" + }, + "ListAgentsRequest":{ + "type":"structure", + "members":{ + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"} + }, + "documentation":"

List Agent Request

" + }, + "ListAgentsResponse":{ + "type":"structure", + "required":["agentSummaries"], + "members":{ + "agentSummaries":{"shape":"AgentSummaries"}, + "nextToken":{"shape":"NextToken"} + }, + "documentation":"

List Agent Response

" + }, + "ListDataSourcesRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListDataSourcesResponse":{ + "type":"structure", + "required":["dataSourceSummaries"], + "members":{ + "dataSourceSummaries":{"shape":"DataSourceSummaries"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListIngestionJobsRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "dataSourceId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "dataSourceId":{ + "shape":"Id", + "location":"uri", + "locationName":"dataSourceId" + }, + "filters":{"shape":"IngestionJobFilters"}, + "sortBy":{"shape":"IngestionJobSortBy"}, + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListIngestionJobsResponse":{ + "type":"structure", + "required":["ingestionJobSummaries"], + "members":{ + "ingestionJobSummaries":{"shape":"IngestionJobSummaries"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListKnowledgeBasesRequest":{ + "type":"structure", + "members":{ + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListKnowledgeBasesResponse":{ + "type":"structure", + "required":["knowledgeBaseSummaries"], + "members":{ + "knowledgeBaseSummaries":{"shape":"KnowledgeBaseSummaries"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"TaggableResourcesArn", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{"shape":"TagsMap"} + } + }, + "MaxResults":{ + "type":"integer", + "documentation":"

Max Results.

", + "box":true, + "max":1000, + "min":1 + }, + "MaximumLength":{ + "type":"integer", + "documentation":"

Maximum length of output

", + "box":true, + "max":4096, + "min":0 + }, + "ModelIdentifier":{ + "type":"string", + "documentation":"

ARN or name of a Bedrock model.

", + "max":2048, + "min":1, + "pattern":".*(^[a-zA-Z0-9-_.]+$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))$)|(^([0-9a-zA-Z][_-]?)+$)|^([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63})" + }, + "Name":{ + "type":"string", + "documentation":"

Name for a resource.

", + "pattern":"([0-9a-zA-Z][_-]?){1,100}" + }, + "NextToken":{ + "type":"string", + "documentation":"

Opaque continuation token of previous paginated response.

", + "max":2048, + "min":1, + "pattern":"\\S*" + }, + "NonBlankString":{ + "type":"string", + "documentation":"

Non Blank String

", + "pattern":"[\\s\\S]+" + }, + "NumericalVersion":{ + "type":"string", + "documentation":"

Numerical Agent Version.

", + "pattern":"[0-9]{1,5}" + }, + "OpenSearchServerlessCollectionArn":{ + "type":"string", + "documentation":"

Arn of an OpenSearch Serverless collection.

", + "max":2048, + "min":0, + "pattern":"arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}" + }, + "OpenSearchServerlessConfiguration":{ + "type":"structure", + "required":[ + "collectionArn", + "vectorIndexName", + "fieldMapping" + ], + "members":{ + "collectionArn":{"shape":"OpenSearchServerlessCollectionArn"}, + "vectorIndexName":{"shape":"OpenSearchServerlessIndexName"}, + "fieldMapping":{"shape":"OpenSearchServerlessFieldMapping"} + }, + "documentation":"

Contains the configurations to use OpenSearch Serverless to store knowledge base data.

" + }, + "OpenSearchServerlessFieldMapping":{ + "type":"structure", + "required":[ + "vectorField", + "textField", + "metadataField" + ], + "members":{ + "vectorField":{"shape":"FieldName"}, + "textField":{"shape":"FieldName"}, + "metadataField":{"shape":"FieldName"} + }, + "documentation":"

A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names

" + }, + "OpenSearchServerlessIndexName":{ + "type":"string", + "documentation":"

Arn of an OpenSearch Serverless index.

", + "max":2048, + "min":0, + "pattern":".*" + }, + "Payload":{ + "type":"string", + "documentation":"

String OpenAPI Payload

", + "sensitive":true + }, + "PineconeConfiguration":{ + "type":"structure", + "required":[ + "connectionString", + "credentialsSecretArn", + "fieldMapping" + ], + "members":{ + "connectionString":{"shape":"PineconeConnectionString"}, + "credentialsSecretArn":{"shape":"SecretArn"}, + "namespace":{"shape":"PineconeNamespace"}, + "fieldMapping":{"shape":"PineconeFieldMapping"} + }, + "documentation":"

Contains the configurations to use Pinecone to store knowledge base data.

" + }, + "PineconeConnectionString":{ + "type":"string", + "documentation":"

Pinecone connection string

", + "max":2048, + "min":0, + "pattern":".*" + }, + "PineconeFieldMapping":{ + "type":"structure", + "required":[ + "textField", + "metadataField" + ], + "members":{ + "textField":{"shape":"FieldName"}, + "metadataField":{"shape":"FieldName"} + }, + "documentation":"

A mapping of Bedrock Knowledge Base fields to Pinecone field names

" + }, + "PineconeNamespace":{ + "type":"string", + "documentation":"

Pinecone namespace

", + "max":2048, + "min":0, + "pattern":".*" + }, + "PrepareAgentRequest":{ + "type":"structure", + "required":["agentId"], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + } + }, + "documentation":"

PrepareAgent Request

" + }, + "PrepareAgentResponse":{ + "type":"structure", + "required":[ + "agentId", + "agentStatus", + "agentVersion", + "preparedAt" + ], + "members":{ + "agentId":{"shape":"Id"}, + "agentStatus":{"shape":"AgentStatus"}, + "agentVersion":{"shape":"Version"}, + "preparedAt":{"shape":"DateTimestamp"} + }, + "documentation":"

PrepareAgent Response

" + }, + "PrimitiveLong":{"type":"long"}, + "PromptConfiguration":{ + "type":"structure", + "members":{ + "promptType":{"shape":"PromptType"}, + "promptCreationMode":{"shape":"CreationMode"}, + "promptState":{"shape":"PromptState"}, + "basePromptTemplate":{"shape":"BasePromptTemplate"}, + "inferenceConfiguration":{"shape":"InferenceConfiguration"}, + "parserMode":{"shape":"CreationMode"} + }, + "documentation":"

BasePromptConfiguration per Prompt Type.

" + }, + "PromptConfigurations":{ + "type":"list", + "member":{"shape":"PromptConfiguration"}, + "documentation":"

List of BasePromptConfiguration

", + "max":10, + "min":0 + }, + "PromptOverrideConfiguration":{ + "type":"structure", + "required":["promptConfigurations"], + "members":{ + "promptConfigurations":{"shape":"PromptConfigurations"}, + "overrideLambda":{"shape":"LambdaArn"} + }, + "documentation":"

Configuration for prompt override.

", + "sensitive":true + }, + "PromptState":{ + "type":"string", + "documentation":"

Prompt State.

", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "PromptType":{ + "type":"string", + "documentation":"

Prompt Type.

", + "enum":[ + "PRE_PROCESSING", + "ORCHESTRATION", + "POST_PROCESSING", + "KNOWLEDGE_BASE_RESPONSE_GENERATION" + ] + }, + "RecommendedAction":{ + "type":"string", + "documentation":"

The recommended action users can take to resolve an error in failureReasons.

", + "max":2048, + "min":0 + }, + "RecommendedActions":{ + "type":"list", + "member":{"shape":"RecommendedAction"}, + "documentation":"

The recommended actions users can take to resolve an error in failureReasons.

", + "max":2048, + "min":0 + }, + "RedisEnterpriseCloudConfiguration":{ + "type":"structure", + "required":[ + "endpoint", + "vectorIndexName", + "credentialsSecretArn", + "fieldMapping" + ], + "members":{ + "endpoint":{"shape":"RedisEnterpriseCloudEndpoint"}, + "vectorIndexName":{"shape":"RedisEnterpriseCloudIndexName"}, + "credentialsSecretArn":{"shape":"SecretArn"}, + "fieldMapping":{"shape":"RedisEnterpriseCloudFieldMapping"} + }, + "documentation":"

Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.

" + }, + "RedisEnterpriseCloudEndpoint":{ + "type":"string", + "documentation":"

Redis enterprise cloud endpoint

", + "max":2048, + "min":0, + "pattern":".*" + }, + "RedisEnterpriseCloudFieldMapping":{ + "type":"structure", + "required":[ + "vectorField", + "textField", + "metadataField" + ], + "members":{ + "vectorField":{"shape":"FieldName"}, + "textField":{"shape":"FieldName"}, + "metadataField":{"shape":"FieldName"} + }, + "documentation":"

A mapping of Bedrock Knowledge Base fields to Redis Cloud field names

" + }, + "RedisEnterpriseCloudIndexName":{ + "type":"string", + "documentation":"

Name of a redis enterprise cloud index

", + "max":2048, + "min":0, + "pattern":".*" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when a resource referenced by the operation does not exist

", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "S3BucketArn":{ + "type":"string", + "documentation":"

A S3 bucket ARN

", + "max":2048, + "min":1, + "pattern":"arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]" + }, + "S3BucketName":{ + "type":"string", + "documentation":"

A bucket in S3.

", + "max":63, + "min":3, + "pattern":"[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]" + }, + "S3DataSourceConfiguration":{ + "type":"structure", + "required":["bucketArn"], + "members":{ + "bucketArn":{"shape":"S3BucketArn"}, + "inclusionPrefixes":{"shape":"S3Prefixes"} + }, + "documentation":"

Configures an S3 data source location.

" + }, + "S3Identifier":{ + "type":"structure", + "members":{ + "s3BucketName":{"shape":"S3BucketName"}, + "s3ObjectKey":{"shape":"S3ObjectKey"} + }, + "documentation":"

The identifier for the S3 resource.

" + }, + "S3ObjectKey":{ + "type":"string", + "documentation":"

A object key in S3.

", + "max":1024, + "min":1, + "pattern":"[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*" + }, + "S3Prefix":{ + "type":"string", + "documentation":"

Prefix for s3 object.

", + "max":300, + "min":1 + }, + "S3Prefixes":{ + "type":"list", + "member":{"shape":"S3Prefix"}, + "documentation":"

A list of S3 prefixes.

", + "max":1, + "min":1 + }, + "SecretArn":{ + "type":"string", + "documentation":"

Arn of a SecretsManager Secret.

", + "pattern":"arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9/_+=.@-]{1,63}" + }, + "ServerSideEncryptionConfiguration":{ + "type":"structure", + "members":{ + "kmsKeyArn":{"shape":"KmsKeyArn"} + }, + "documentation":"

Server-side encryption configuration.

" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when a request is made beyond the service quota

", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SessionTTL":{ + "type":"integer", + "documentation":"

Max Session Time.

", + "box":true, + "max":3600, + "min":60 + }, + "SortOrder":{ + "type":"string", + "documentation":"

Order to sort results by.

", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, + "StartIngestionJobRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "dataSourceId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "dataSourceId":{ + "shape":"Id", + "location":"uri", + "locationName":"dataSourceId" + }, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "description":{"shape":"Description"} + } + }, + "StartIngestionJobResponse":{ + "type":"structure", + "required":["ingestionJob"], + "members":{ + "ingestionJob":{"shape":"IngestionJob"} + } + }, + "StopSequences":{ + "type":"list", + "member":{"shape":"String"}, + "documentation":"

List of stop sequences

", + "max":4, + "min":0 + }, + "StorageConfiguration":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{"shape":"KnowledgeBaseStorageType"}, + "opensearchServerlessConfiguration":{"shape":"OpenSearchServerlessConfiguration"}, + "pineconeConfiguration":{"shape":"PineconeConfiguration"}, + "redisEnterpriseCloudConfiguration":{"shape":"RedisEnterpriseCloudConfiguration"} + }, + "documentation":"

Configures the physical storage of ingested data in a knowledge base.

" + }, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "documentation":"

Key of a tag

", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "documentation":"

List of Tag Keys

", + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"TaggableResourcesArn", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{"shape":"TagsMap"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "documentation":"

Value of a tag

", + "max":256, + "min":0, + "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" + }, + "TaggableResourcesArn":{ + "type":"string", + "documentation":"

ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]

", + "max":1011, + "min":20, + "pattern":".*(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$).*" + }, + "TagsMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "documentation":"

A map of tag keys and values

" + }, + "Temperature":{ + "type":"float", + "documentation":"

Controls randomness, higher values increase diversity

", + "box":true, + "max":1, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"} + }, + "documentation":"

This exception is thrown when the number of requests exceeds the limit

", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "TopK":{ + "type":"integer", + "documentation":"

Sample from the k most likely next tokens

", + "box":true, + "max":500, + "min":0 + }, + "TopP":{ + "type":"float", + "documentation":"

Cumulative probability cutoff for token selection

", + "box":true, + "max":1, + "min":0 + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"TaggableResourcesArn", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateAgentActionGroupRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "actionGroupId", + "actionGroupName" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"DraftVersion", + "documentation":"

Draft Version of the Agent.

", + "location":"uri", + "locationName":"agentVersion" + }, + "actionGroupId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Action Group is created under Agent

", + "location":"uri", + "locationName":"actionGroupId" + }, + "actionGroupName":{"shape":"Name"}, + "description":{"shape":"Description"}, + "parentActionGroupSignature":{"shape":"ActionGroupSignature"}, + "actionGroupExecutor":{"shape":"ActionGroupExecutor"}, + "actionGroupState":{"shape":"ActionGroupState"}, + "apiSchema":{"shape":"APISchema"} + }, + "documentation":"

Update Action Group Request

" + }, + "UpdateAgentActionGroupResponse":{ + "type":"structure", + "required":["agentActionGroup"], + "members":{ + "agentActionGroup":{"shape":"AgentActionGroup"} + }, + "documentation":"

Update Action Group Response

" + }, + "UpdateAgentAliasRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentAliasId", + "agentAliasName" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"

Id generated at the server side when an Agent Alias is created

", + "location":"uri", + "locationName":"agentAliasId" + }, + "agentAliasName":{"shape":"Name"}, + "description":{"shape":"Description"}, + "routingConfiguration":{"shape":"AgentAliasRoutingConfiguration"} + }, + "documentation":"

Update Agent Alias Request

" + }, + "UpdateAgentAliasResponse":{ + "type":"structure", + "required":["agentAlias"], + "members":{ + "agentAlias":{"shape":"AgentAlias"} + }, + "documentation":"

Update Agent Alias Response

" + }, + "UpdateAgentKnowledgeBaseRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "knowledgeBaseId" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"DraftVersion", + "documentation":"

Draft Version of the Agent.

", + "location":"uri", + "locationName":"agentVersion" + }, + "knowledgeBaseId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when a Knowledge Base is associated to an Agent

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "description":{"shape":"Description"}, + "knowledgeBaseState":{"shape":"KnowledgeBaseState"} + }, + "documentation":"

Update Agent Knowledge Base Request

" + }, + "UpdateAgentKnowledgeBaseResponse":{ + "type":"structure", + "required":["agentKnowledgeBase"], + "members":{ + "agentKnowledgeBase":{"shape":"AgentKnowledgeBase"} + }, + "documentation":"

Update Agent Knowledge Base Response

" + }, + "UpdateAgentRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentName", + "agentResourceRoleArn" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"

Id generated at the server side when an Agent is created

", + "location":"uri", + "locationName":"agentId" + }, + "agentName":{"shape":"Name"}, + "instruction":{"shape":"Instruction"}, + "foundationModel":{"shape":"ModelIdentifier"}, + "description":{"shape":"Description"}, + "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, + "agentResourceRoleArn":{"shape":"AgentRoleArn"}, + "customerEncryptionKeyArn":{"shape":"KmsKeyArn"}, + "promptOverrideConfiguration":{"shape":"PromptOverrideConfiguration"} + }, + "documentation":"

Update Agent Request

" + }, + "UpdateAgentResponse":{ + "type":"structure", + "required":["agent"], + "members":{ + "agent":{"shape":"Agent"} + }, + "documentation":"

Update Agent Response

" + }, + "UpdateDataSourceRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "dataSourceId", + "name", + "dataSourceConfiguration" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "dataSourceId":{ + "shape":"Id", + "location":"uri", + "locationName":"dataSourceId" + }, + "name":{"shape":"Name"}, + "description":{"shape":"Description"}, + "dataSourceConfiguration":{"shape":"DataSourceConfiguration"}, + "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "vectorIngestionConfiguration":{"shape":"VectorIngestionConfiguration"} + } + }, + "UpdateDataSourceResponse":{ + "type":"structure", + "required":["dataSource"], + "members":{ + "dataSource":{"shape":"DataSource"} + } + }, + "UpdateKnowledgeBaseRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "name", + "roleArn", + "knowledgeBaseConfiguration", + "storageConfiguration" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "name":{"shape":"Name"}, + "description":{"shape":"Description"}, + "roleArn":{"shape":"KnowledgeBaseRoleArn"}, + "knowledgeBaseConfiguration":{"shape":"KnowledgeBaseConfiguration"}, + "storageConfiguration":{"shape":"StorageConfiguration"} + } + }, + "UpdateKnowledgeBaseResponse":{ + "type":"structure", + "required":["knowledgeBase"], + "members":{ + "knowledgeBase":{"shape":"KnowledgeBase"} + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"NonBlankString"}, + "fieldList":{"shape":"ValidationExceptionFieldList"} + }, + "documentation":"

This exception is thrown when the request's input validation fails

", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "name", + "message" + ], + "members":{ + "name":{"shape":"NonBlankString"}, + "message":{"shape":"NonBlankString"} + }, + "documentation":"

Stores information about a field passed inside a request that resulted in an exception

" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"}, + "documentation":"

list of ValidationExceptionField

" + }, + "VectorIngestionConfiguration":{ + "type":"structure", + "members":{ + "chunkingConfiguration":{"shape":"ChunkingConfiguration"} + }, + "documentation":"

Configures ingestion for a vector knowledge base

" + }, + "VectorKnowledgeBaseConfiguration":{ + "type":"structure", + "required":["embeddingModelArn"], + "members":{ + "embeddingModelArn":{"shape":"BedrockEmbeddingModelArn"} + }, + "documentation":"

Configurations for a vector knowledge base.

" + }, + "Version":{ + "type":"string", + "documentation":"

Agent Version.

", + "max":5, + "min":1, + "pattern":"(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})" + } + }, + "documentation":"

An example service, deployed with the Octane Service creator, which will echo the string

" +} diff --git a/botocore/data/bedrock-runtime/2023-09-30/endpoint-rule-set-1.json b/botocore/data/bedrock-runtime/2023-09-30/endpoint-rule-set-1.json index be978fd08f..6c3f1fbf1a 100644 --- a/botocore/data/bedrock-runtime/2023-09-30/endpoint-rule-set-1.json +++ b/botocore/data/bedrock-runtime/2023-09-30/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -59,7 +58,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -87,13 +85,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -106,7 +105,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -120,7 +118,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -143,7 +140,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -178,11 +174,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -193,16 +187,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -216,14 +213,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -232,15 +227,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -251,16 +245,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -274,7 +271,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -294,11 +290,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -309,20 +303,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -333,18 +329,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] } \ No newline at end of file diff --git a/botocore/data/bedrock-runtime/2023-09-30/service-2.json b/botocore/data/bedrock-runtime/2023-09-30/service-2.json index ec2f9a3dfd..e782a19875 100644 --- a/botocore/data/bedrock-runtime/2023-09-30/service-2.json +++ b/botocore/data/bedrock-runtime/2023-09-30/service-2.json @@ -91,7 +91,7 @@ "type":"string", "max":2048, "min":1, - "pattern":"^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + "pattern":"(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)" }, "InvokeModelRequest":{ "type":"structure", @@ -100,12 +100,6 @@ "modelId" ], "members":{ - "accept":{ - "shape":"MimeType", - "documentation":"

The desired MIME type of the inference body in the response. The default value is application/json.

", - "location":"header", - "locationName":"Accept" - }, "body":{ "shape":"Body", "documentation":"

Input data in the format specified in the content-type request header. To see the format and content of this field for different models, refer to Inference parameters.

" @@ -116,6 +110,12 @@ "location":"header", "locationName":"Content-Type" }, + "accept":{ + "shape":"MimeType", + "documentation":"

The desired MIME type of the inference body in the response. The default value is application/json.

", + "location":"header", + "locationName":"Accept" + }, "modelId":{ "shape":"InvokeModelIdentifier", "documentation":"

Identifier of the model.

", @@ -152,12 +152,6 @@ "modelId" ], "members":{ - "accept":{ - "shape":"MimeType", - "documentation":"

The desired MIME type of the inference body in the response. The default value is application/json.

", - "location":"header", - "locationName":"X-Amzn-Bedrock-Accept" - }, "body":{ "shape":"Body", "documentation":"

Inference input in the format specified by the content-type. To see the format and content of this field for different models, refer to Inference parameters.

" @@ -168,6 +162,12 @@ "location":"header", "locationName":"Content-Type" }, + "accept":{ + "shape":"MimeType", + "documentation":"

The desired MIME type of the inference body in the response. The default value is application/json.

", + "location":"header", + "locationName":"X-Amzn-Bedrock-Accept" + }, "modelId":{ "shape":"InvokeModelIdentifier", "documentation":"

Id of the model to invoke using the streaming request.

", @@ -234,13 +234,13 @@ "type":"structure", "members":{ "message":{"shape":"NonBlankString"}, - "originalMessage":{ - "shape":"NonBlankString", - "documentation":"

The original message.

" - }, "originalStatusCode":{ "shape":"StatusCode", "documentation":"

The original status code.

" + }, + "originalMessage":{ + "shape":"NonBlankString", + "documentation":"

The original message.

" } }, "documentation":"

An error occurred while streaming the response.

", @@ -264,7 +264,7 @@ }, "NonBlankString":{ "type":"string", - "pattern":"^[\\s\\S]*$" + "pattern":"[\\s\\S]*" }, "PartBody":{ "type":"blob", @@ -305,9 +305,9 @@ }, "internalServerException":{"shape":"InternalServerException"}, "modelStreamErrorException":{"shape":"ModelStreamErrorException"}, - "modelTimeoutException":{"shape":"ModelTimeoutException"}, + "validationException":{"shape":"ValidationException"}, "throttlingException":{"shape":"ThrottlingException"}, - "validationException":{"shape":"ValidationException"} + "modelTimeoutException":{"shape":"ModelTimeoutException"} }, "documentation":"

Definition of content in the response stream.

", "eventstream":true diff --git a/botocore/data/bedrock-runtime/2023-09-30/waiters-2.json b/botocore/data/bedrock-runtime/2023-09-30/waiters-2.json new file mode 100644 index 0000000000..4b20636aa4 --- /dev/null +++ b/botocore/data/bedrock-runtime/2023-09-30/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} \ No newline at end of file diff --git a/botocore/data/bedrock/2023-04-20/endpoint-rule-set-1.json b/botocore/data/bedrock/2023-04-20/endpoint-rule-set-1.json index 51da5236ec..b04f6c8cbb 100644 --- a/botocore/data/bedrock/2023-04-20/endpoint-rule-set-1.json +++ b/botocore/data/bedrock/2023-04-20/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -59,7 +58,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -87,13 +85,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -106,7 +105,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -120,7 +118,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -143,7 +140,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -178,11 +174,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -193,16 +187,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -216,14 +213,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -232,15 +227,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -251,16 +245,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -274,7 +271,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -294,11 +290,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -309,20 +303,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -333,18 +329,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] } \ No newline at end of file diff --git a/botocore/data/bedrock/2023-04-20/service-2.json b/botocore/data/bedrock/2023-04-20/service-2.json index 0d18e1f21a..5bc66fe4d0 100644 --- a/botocore/data/bedrock/2023-04-20/service-2.json +++ b/botocore/data/bedrock/2023-04-20/service-2.json @@ -31,7 +31,7 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Creates a fine-tuning job to customize a base model.

You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Training data contains input and output text for each record in a JSONL format. Optionally, you can specify validation data in the same format as the training data. Bedrock returns validation loss metrics and output generations after the job completes.

Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

For more information, see Custom models in the Bedrock User Guide.

", + "documentation":"

Creates a fine-tuning job to customize a base model.

You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Training data contains input and output text for each record in a JSONL format. Optionally, you can specify validation data in the same format as the training data. Amazon Bedrock returns validation loss metrics and output generations after the job completes.

Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

For more information, see Custom models in the Bedrock User Guide.

", "idempotent":true }, "CreateProvisionedModelThroughput":{ @@ -128,7 +128,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Get the properties associated with a Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.

" + "documentation":"

Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.

" }, "GetFoundationModel":{ "name":"GetFoundationModel", @@ -146,7 +146,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Get details about a Bedrock foundation model.

" + "documentation":"

Get details about a Amazon Bedrock foundation model.

" }, "GetModelCustomizationJob":{ "name":"GetModelCustomizationJob", @@ -232,7 +232,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"

List of Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.

" + "documentation":"

List of Amazon Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.

" }, "ListModelCustomizationJobs":{ "name":"ListModelCustomizationJobs", @@ -398,7 +398,7 @@ "type":"string", "max":2048, "min":1, - "pattern":"(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)" + "pattern":"(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)" }, "BedrockModelId":{ "type":"string", @@ -484,7 +484,7 @@ }, "roleArn":{ "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Bedrock can assume to perform tasks on your behalf. For example, during model training, Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Bedrock, the caller of this API must have the iam:PassRole permission.

" + "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.

" }, "clientRequestToken":{ "shape":"IdempotencyToken", @@ -495,6 +495,10 @@ "shape":"BaseModelIdentifier", "documentation":"

Name of the base model.

" }, + "customizationType":{ + "shape":"CustomizationType", + "documentation":"

The customization type.

" + }, "customModelKmsKeyId":{ "shape":"KmsKeyId", "documentation":"

The custom model is encrypted at rest using this key.

" @@ -549,7 +553,7 @@ "members":{ "clientRequestToken":{ "shape":"IdempotencyToken", - "documentation":"

Unique token value that you can provide. If this token matches a previous request, Bedrock ignores the request, but does not return an error.

", + "documentation":"

Unique token value that you can provide. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.

", "idempotencyToken":true }, "modelUnits":{ @@ -625,6 +629,10 @@ "baseModelName":{ "shape":"ModelName", "documentation":"

The base model name.

" + }, + "customizationType":{ + "shape":"CustomizationType", + "documentation":"

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

" } }, "documentation":"

Summary information for a custom model.

" @@ -633,6 +641,13 @@ "type":"list", "member":{"shape":"CustomModelSummary"} }, + "CustomizationType":{ + "type":"string", + "enum":[ + "FINE_TUNING", + "CONTINUED_PRE_TRAINING" + ] + }, "DeleteCustomModelRequest":{ "type":"structure", "required":["modelIdentifier"], @@ -738,10 +753,32 @@ "inferenceTypesSupported":{ "shape":"InferenceTypeList", "documentation":"

The inference types that the model supports.

" + }, + "modelLifecycle":{ + "shape":"FoundationModelLifecycle", + "documentation":"

Contains details about whether a model version is available or deprecated

" } }, "documentation":"

Information about a foundation model.

" }, + "FoundationModelLifecycle":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"FoundationModelLifecycleStatus", + "documentation":"

Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.

" + } + }, + "documentation":"

Details about whether a model version is available or deprecated.

" + }, + "FoundationModelLifecycleStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "LEGACY" + ] + }, "FoundationModelSummary":{ "type":"structure", "required":[ @@ -784,6 +821,10 @@ "inferenceTypesSupported":{ "shape":"InferenceTypeList", "documentation":"

The inference types that the model supports.

" + }, + "modelLifecycle":{ + "shape":"FoundationModelLifecycle", + "documentation":"

Contains details about whether a model version is available or deprecated.

" } }, "documentation":"

Summary information for a foundation model.

" @@ -836,6 +877,10 @@ "shape":"ModelArn", "documentation":"

ARN of the base model.

" }, + "customizationType":{ + "shape":"CustomizationType", + "documentation":"

The type of model customization.

" + }, "modelKmsKeyArn":{ "shape":"KmsKeyArn", "documentation":"

The custom model is encrypted at rest using this key.

" @@ -965,7 +1010,7 @@ }, "hyperParameters":{ "shape":"ModelCustomizationHyperParameters", - "documentation":"

The hyperparameter values for the job.

" + "documentation":"

The hyperparameter values for the job. For information about hyperparameters for specific models, see Guidelines for model customization.

" }, "trainingDataConfig":{"shape":"TrainingDataConfig"}, "validationDataConfig":{"shape":"ValidationDataConfig"}, @@ -973,6 +1018,10 @@ "shape":"OutputDataConfig", "documentation":"

Output data configuration

" }, + "customizationType":{ + "shape":"CustomizationType", + "documentation":"

The type of model customization.

" + }, "outputModelKmsKeyArn":{ "shape":"KmsKeyArn", "documentation":"

The custom model is encrypted at rest using this key.

" @@ -1174,7 +1223,7 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

Continuation token from the previous response, for Bedrock to list the next set of results.

", + "documentation":"

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

", "location":"querystring", "locationName":"nextToken" }, @@ -1210,7 +1259,7 @@ "members":{ "byProvider":{ "shape":"Provider", - "documentation":"

A Bedrock model provider.

", + "documentation":"

A Amazon Bedrock model provider.

", "location":"querystring", "locationName":"byProvider" }, @@ -1239,7 +1288,7 @@ "members":{ "modelSummaries":{ "shape":"FoundationModelSummaryList", - "documentation":"

A list of bedrock foundation models.

" + "documentation":"

A list of Amazon Bedrock foundation models.

" } } }, @@ -1278,7 +1327,7 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

Continuation token from the previous response, for Bedrock to list the next set of results.

", + "documentation":"

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

", "location":"querystring", "locationName":"nextToken" }, @@ -1350,7 +1399,7 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

Continuation token from the previous response, for Bedrock to list the next set of results.

", + "documentation":"

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

", "location":"querystring", "locationName":"nextToken" }, @@ -1449,7 +1498,10 @@ }, "ModelCustomization":{ "type":"string", - "enum":["FINE_TUNING"] + "enum":[ + "FINE_TUNING", + "CONTINUED_PRE_TRAINING" + ] }, "ModelCustomizationHyperParameters":{ "type":"map", @@ -1527,6 +1579,10 @@ "customModelName":{ "shape":"CustomModelName", "documentation":"

Name of the custom model.

" + }, + "customizationType":{ + "shape":"CustomizationType", + "documentation":"

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

" } }, "documentation":"

Information about one customization job

" @@ -1587,7 +1643,7 @@ }, "Provider":{ "type":"string", - "pattern":"[a-z0-9-]{1,63}" + "pattern":"[A-Za-z0-9- ]{1,63}" }, "ProvisionedModelArn":{ "type":"string", @@ -2052,5 +2108,5 @@ "documentation":"

VPC configuration.

" } }, - "documentation":"

Describes the API operations for creating and managing Bedrock models.

" + "documentation":"

Describes the API operations for creating and managing Amazon Bedrock models.

" } diff --git a/botocore/data/connect/2017-08-08/paginators-1.json b/botocore/data/connect/2017-08-08/paginators-1.json index 8e0d01fd19..77f0148024 100644 --- a/botocore/data/connect/2017-08-08/paginators-1.json +++ b/botocore/data/connect/2017-08-08/paginators-1.json @@ -328,6 +328,12 @@ "LastModifiedRegion", "LastModifiedTime" ] + }, + "ListFlowAssociations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "FlowAssociationSummaryList" } } } diff --git a/botocore/data/connect/2017-08-08/service-2.json b/botocore/data/connect/2017-08-08/service-2.json index e50a024e1a..d51d633a04 100644 --- a/botocore/data/connect/2017-08-08/service-2.json +++ b/botocore/data/connect/2017-08-08/service-2.json @@ -30,6 +30,23 @@ ], "documentation":"

Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.

" }, + "AssociateAnalyticsDataSet":{ + "name":"AssociateAnalyticsDataSet", + "http":{ + "method":"PUT", + "requestUri":"/analytics-data/instance/{InstanceId}/association" + }, + "input":{"shape":"AssociateAnalyticsDataSetRequest"}, + "output":{"shape":"AssociateAnalyticsDataSetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

This API is in preview release for Amazon Connect and is subject to change.

Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

" + }, "AssociateApprovedOrigin":{ "name":"AssociateApprovedOrigin", "http":{ @@ -83,6 +100,24 @@ ], "documentation":"

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

" }, + "AssociateFlow":{ + "name":"AssociateFlow", + "http":{ + "method":"PUT", + "requestUri":"/flow-associations/{InstanceId}" + }, + "input":{"shape":"AssociateFlowRequest"}, + "output":{"shape":"AssociateFlowResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Associates a connect resource to a flow.

" + }, "AssociateInstanceStorageConfig":{ "name":"AssociateInstanceStorageConfig", "http":{ @@ -224,6 +259,40 @@ "documentation":"

Associates an agent with a traffic distribution group.

", "idempotent":true }, + "BatchAssociateAnalyticsDataSet":{ + "name":"BatchAssociateAnalyticsDataSet", + "http":{ + "method":"PUT", + "requestUri":"/analytics-data/instance/{InstanceId}/associations" + }, + "input":{"shape":"BatchAssociateAnalyticsDataSetRequest"}, + "output":{"shape":"BatchAssociateAnalyticsDataSetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

This API is in preview release for Amazon Connect and is subject to change.

Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.

" + }, + "BatchDisassociateAnalyticsDataSet":{ + "name":"BatchDisassociateAnalyticsDataSet", + "http":{ + "method":"POST", + "requestUri":"/analytics-data/instance/{InstanceId}/associations" + }, + "input":{"shape":"BatchDisassociateAnalyticsDataSetRequest"}, + "output":{"shape":"BatchDisassociateAnalyticsDataSetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

This API is in preview release for Amazon Connect and is subject to change.

Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.

" + }, "BatchGetFlowAssociation":{ "name":"BatchGetFlowAssociation", "http":{ @@ -632,7 +701,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Creates a user account for the specified Amazon Connect instance.

Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

" + "documentation":"

Creates a user account for the specified Amazon Connect instance.

Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.

For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.

" }, "CreateUserHierarchyGroup":{ "name":"CreateUserHierarchyGroup", @@ -1404,7 +1473,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Describes the specified user account. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

" + "documentation":"

Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

" }, "DescribeUserHierarchyGroup":{ "name":"DescribeUserHierarchyGroup", @@ -1475,6 +1544,22 @@ ], "documentation":"

Describes the specified vocabulary.

" }, + "DisassociateAnalyticsDataSet":{ + "name":"DisassociateAnalyticsDataSet", + "http":{ + "method":"POST", + "requestUri":"/analytics-data/instance/{InstanceId}/association" + }, + "input":{"shape":"DisassociateAnalyticsDataSetRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

This API is in preview release for Amazon Connect and is subject to change.

Removes the dataset ID associated with a given Amazon Connect instance.

" + }, "DisassociateApprovedOrigin":{ "name":"DisassociateApprovedOrigin", "http":{ @@ -1506,6 +1591,24 @@ ], "documentation":"

This API is in preview release for Amazon Connect and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

" }, + "DisassociateFlow":{ + "name":"DisassociateFlow", + "http":{ + "method":"DELETE", + "requestUri":"/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}" + }, + "input":{"shape":"DisassociateFlowRequest"}, + "output":{"shape":"DisassociateFlowResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Disassociates a connect resource from a flow.

" + }, "DisassociateInstanceStorageConfig":{ "name":"DisassociateInstanceStorageConfig", "http":{ @@ -1722,6 +1825,24 @@ ], "documentation":"

Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.

For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.

This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

" }, + "GetFlowAssociation":{ + "name":"GetFlowAssociation", + "http":{ + "method":"GET", + "requestUri":"/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}" + }, + "input":{"shape":"GetFlowAssociationRequest"}, + "output":{"shape":"GetFlowAssociationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves the flow associated for a given resource.

" + }, "GetMetricData":{ "name":"GetMetricData", "http":{ @@ -1807,6 +1928,24 @@ ], "documentation":"

Retrieves the current traffic distribution for a given traffic distribution group.

" }, + "ImportPhoneNumber":{ + "name":"ImportPhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/phone-number/import" + }, + "input":{"shape":"ImportPhoneNumberRequest"}, + "output":{"shape":"ImportPhoneNumberResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"}, + {"shape":"IdempotencyException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.

" + }, "ListAgentStatuses":{ "name":"ListAgentStatuses", "http":{ @@ -1824,6 +1963,23 @@ ], "documentation":"

This API is in preview release for Amazon Connect and is subject to change.

Lists agent statuses.

" }, + "ListAnalyticsDataAssociations":{ + "name":"ListAnalyticsDataAssociations", + "http":{ + "method":"GET", + "requestUri":"/analytics-data/instance/{InstanceId}/association" + }, + "input":{"shape":"ListAnalyticsDataAssociationsRequest"}, + "output":{"shape":"ListAnalyticsDataAssociationsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

This API is in preview release for Amazon Connect and is subject to change.

Lists the association status of requested dataset ID for a given Amazon Connect instance.

" + }, "ListApprovedOrigins":{ "name":"ListApprovedOrigins", "http":{ @@ -1973,6 +2129,24 @@ ], "documentation":"

Lists evaluation forms in the specified Amazon Connect instance.

" }, + "ListFlowAssociations":{ + "name":"ListFlowAssociations", + "http":{ + "method":"GET", + "requestUri":"/flow-associations-summary/{InstanceId}" + }, + "input":{"shape":"ListFlowAssociationsRequest"}, + "output":{"shape":"ListFlowAssociationsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

List the flow association based on the filters.

" + }, "ListHoursOfOperations":{ "name":"ListHoursOfOperations", "http":{ @@ -2190,6 +2364,24 @@ ], "documentation":"

Provides information about the quick connects for the specified Amazon Connect instance.

" }, + "ListRealtimeContactAnalysisSegmentsV2":{ + "name":"ListRealtimeContactAnalysisSegmentsV2", + "http":{ + "method":"POST", + "requestUri":"/contact/list-real-time-analysis-segments-v2/{InstanceId}/{ContactId}" + }, + "input":{"shape":"ListRealtimeContactAnalysisSegmentsV2Request"}, + "output":{"shape":"ListRealtimeContactAnalysisSegmentsV2Response"}, + "errors":[ + {"shape":"OutputTypeNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Provides a list of analysis segments for a real-time analysis session.

" + }, "ListRoutingProfileQueues":{ "name":"ListRoutingProfileQueues", "http":{ @@ -2515,7 +2707,7 @@ {"shape":"IdempotencyException"}, {"shape":"AccessDeniedException"} ], - "documentation":"

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect console.

After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.

If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

" + "documentation":"

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.

After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.

If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

" }, "ReplicateInstance":{ "name":"ReplicateInstance", @@ -2721,6 +2913,23 @@ ], "documentation":"

Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

" }, + "SendChatIntegrationEvent":{ + "name":"SendChatIntegrationEvent", + "http":{ + "method":"POST", + "requestUri":"/chat-integration-event" + }, + "input":{"shape":"SendChatIntegrationEventRequest"}, + "output":{"shape":"SendChatIntegrationEventResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:

  • SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat

  • ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.

Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.

" + }, "StartChatContact":{ "name":"StartChatContact", "http":{ @@ -2827,6 +3036,23 @@ ], "documentation":"

Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.

When using PreviousContactId and RelatedContactId input parameters, note the following:

  • PreviousContactId

    • Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.

    • There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.

  • RelatedContactId

    • Copies contact attributes from the related task contact to the new contact.

    • Any update on attributes in a new task contact does not update attributes on previous contact.

    • There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.

In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.

A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.

" }, + "StartWebRTCContact":{ + "name":"StartWebRTCContact", + "http":{ + "method":"PUT", + "requestUri":"/contact/webrtc" + }, + "input":{"shape":"StartWebRTCContactRequest"}, + "output":{"shape":"StartWebRTCContactResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

" + }, "StopContact":{ "name":"StopContact", "http":{ @@ -3695,6 +3921,7 @@ }, "shapes":{ "ARN":{"type":"string"}, + "AWSAccountId":{"type":"string"}, "AccessDeniedException":{ "type":"structure", "members":{ @@ -4018,11 +4245,51 @@ "value":{"shape":"SecurityProfilePolicyValue"}, "max":2 }, + "AllowedCapabilities":{ + "type":"structure", + "members":{ + "Customer":{ + "shape":"ParticipantCapabilities", + "documentation":"

Information about the customer's video sharing capabilities.

" + }, + "Agent":{ + "shape":"ParticipantCapabilities", + "documentation":"

Information about the agent's video sharing capabilities.

" + } + }, + "documentation":"

Information about the capabilities enabled for participants of the contact.

" + }, "AllowedMonitorCapabilities":{ "type":"list", "member":{"shape":"MonitorCapability"}, "max":2 }, + "AnalyticsDataAssociationResult":{ + "type":"structure", + "members":{ + "DataSetId":{ + "shape":"DataSetId", + "documentation":"

The identifier of the dataset.

" + }, + "TargetAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The identifier of the target account.

" + }, + "ResourceShareId":{ + "shape":"String", + "documentation":"

The Resource Access Manager share ID.

" + }, + "ResourceShareArn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the Resource Access Manager share.

" + } + }, + "documentation":"

This API is in preview release for Amazon Connect and is subject to change.

Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn.

" + }, + "AnalyticsDataAssociationResults":{ + "type":"list", + "member":{"shape":"AnalyticsDataAssociationResult"} + }, "AnswerMachineDetectionConfig":{ "type":"structure", "members":{ @@ -4063,11 +4330,68 @@ "max":10 }, "ApproximateTotalCount":{"type":"long"}, + "ArtifactId":{ + "type":"string", + "max":256, + "min":1 + }, + "ArtifactStatus":{ + "type":"string", + "enum":[ + "APPROVED", + "REJECTED", + "IN_PROGRESS" + ] + }, "AssignContactCategoryActionDefinition":{ "type":"structure", "members":{ }, - "documentation":"

This action must be set if TriggerEventSource is one of the following values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnPostChatAnalysisAvailable. Contact is categorized using the rule name.

RuleName is used as ContactCategory.

" + "documentation":"

This action must be set if TriggerEventSource is one of the following values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable. Contact is categorized using the rule name.

RuleName is used as ContactCategory.

" + }, + "AssociateAnalyticsDataSetRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "DataSetId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "DataSetId":{ + "shape":"DataSetId", + "documentation":"

The identifier of the dataset to associate with the target account.

" + }, + "TargetAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

" + } + } + }, + "AssociateAnalyticsDataSetResponse":{ + "type":"structure", + "members":{ + "DataSetId":{ + "shape":"DataSetId", + "documentation":"

The identifier of the dataset that was associated.

" + }, + "TargetAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The identifier of the target account.

" + }, + "ResourceShareId":{ + "shape":"String", + "documentation":"

The Resource Access Manager share ID that is generated.

" + }, + "ResourceShareArn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the Resource Access Manager share.

" + } + } }, "AssociateApprovedOriginRequest":{ "type":"structure", @@ -4135,6 +4459,40 @@ "members":{ } }, + "AssociateFlowRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "ResourceId", + "FlowId", + "ResourceType" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "ResourceId":{ + "shape":"ARN", + "documentation":"

The identifier of the resource.

" + }, + "FlowId":{ + "shape":"ARN", + "documentation":"

The identifier of the flow.

" + }, + "ResourceType":{ + "shape":"FlowAssociationResourceType", + "documentation":"

A valid resource type.

" + } + } + }, + "AssociateFlowResponse":{ + "type":"structure", + "members":{ + } + }, "AssociateInstanceStorageConfigRequest":{ "type":"structure", "required":[ @@ -4344,6 +4702,11 @@ "max":100, "min":1 }, + "AttachmentName":{ + "type":"string", + "max":256, + "min":1 + }, "AttachmentReference":{ "type":"structure", "members":{ @@ -4362,6 +4725,21 @@ }, "documentation":"

Information about a reference when the referenceType is ATTACHMENT. Otherwise, null.

" }, + "Attendee":{ + "type":"structure", + "members":{ + "AttendeeId":{ + "shape":"AttendeeId", + "documentation":"

The Amazon Chime SDK attendee ID.

" + }, + "JoinToken":{ + "shape":"JoinToken", + "documentation":"

The join token used by the Amazon Chime SDK attendee.

" + } + }, + "documentation":"

The attendee information, including attendee ID and join token.

" + }, + "AttendeeId":{"type":"string"}, "Attribute":{ "type":"structure", "members":{ @@ -4395,6 +4773,16 @@ "type":"list", "member":{"shape":"Attribute"} }, + "AudioFeatures":{ + "type":"structure", + "members":{ + "EchoReduction":{ + "shape":"MeetingFeatureStatus", + "documentation":"

Makes echo reduction available to clients who connect to the meeting.

" + } + }, + "documentation":"

Has audio-specific configurations as the operating parameter for Echo Reduction.

" + }, "AutoAccept":{"type":"boolean"}, "AvailableNumberSummary":{ "type":"structure", @@ -4424,11 +4812,11 @@ "min":8, "pattern":"[a-z]{2}(-[a-z]+){1,2}(-[0-9])?" }, - "BatchGetFlowAssociationRequest":{ + "BatchAssociateAnalyticsDataSetRequest":{ "type":"structure", "required":[ "InstanceId", - "ResourceIds" + "DataSetIds" ], "members":{ "InstanceId":{ @@ -4437,22 +4825,94 @@ "location":"uri", "locationName":"InstanceId" }, - "ResourceIds":{ - "shape":"resourceArnListMaxLimit100", - "documentation":"

A list of resource identifiers to retrieve flow associations.

" + "DataSetIds":{ + "shape":"DataSetIds", + "documentation":"

An array of dataset identifiers to associate.

" }, - "ResourceType":{ - "shape":"ListFlowAssociationResourceType", - "documentation":"

The type of resource association.

" + "TargetAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

" } } }, - "BatchGetFlowAssociationResponse":{ + "BatchAssociateAnalyticsDataSetResponse":{ "type":"structure", "members":{ - "FlowAssociationSummaryList":{ - "shape":"FlowAssociationSummaryList", - "documentation":"

Information about flow associations.

" + "Created":{ + "shape":"AnalyticsDataAssociationResults", + "documentation":"

Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn.

" + }, + "Errors":{ + "shape":"ErrorResults", + "documentation":"

A list of errors for datasets that aren't successfully associated with the target account.

" + } + } + }, + "BatchDisassociateAnalyticsDataSetRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "DataSetIds" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "DataSetIds":{ + "shape":"DataSetIds", + "documentation":"

An array of associated dataset identifiers to remove.

" + }, + "TargetAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

" + } + } + }, + "BatchDisassociateAnalyticsDataSetResponse":{ + "type":"structure", + "members":{ + "Deleted":{ + "shape":"DataSetIds", + "documentation":"

An array of successfully disassociated dataset identifiers.

" + }, + "Errors":{ + "shape":"ErrorResults", + "documentation":"

A list of errors for any datasets not successfully removed.

" + } + } + }, + "BatchGetFlowAssociationRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "ResourceIds" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "ResourceIds":{ + "shape":"resourceArnListMaxLimit100", + "documentation":"

A list of resource identifiers to retrieve flow associations.

" + }, + "ResourceType":{ + "shape":"ListFlowAssociationResourceType", + "documentation":"

The type of resource association.

" + } + } + }, + "BatchGetFlowAssociationResponse":{ + "type":"structure", + "members":{ + "FlowAssociationSummaryList":{ + "shape":"FlowAssociationSummaryList", + "documentation":"

Information about flow associations.

" } } }, @@ -4559,6 +5019,33 @@ "max":10080, "min":60 }, + "ChatEvent":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"ChatEventType", + "documentation":"

Type of chat integration event.

" + }, + "ContentType":{ + "shape":"ChatContentType", + "documentation":"

Type of content. This is required when Type is MESSAGE or EVENT.

  • For allowed message content types, see the ContentType parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.

  • For allowed event content types, see the ContentType parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.

" + }, + "Content":{ + "shape":"ChatContent", + "documentation":"

Content of the message or event. This is required when Type is MESSAGE and for certain ContentTypes when Type is EVENT.

  • For allowed message content, see the Content parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.

  • For allowed event content, see the Content parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.

" + } + }, + "documentation":"

Chat integration event containing payload to perform different chat actions such as:

  • Sending a chat message

  • Sending a chat event, such as typing

  • Disconnecting from a chat

" + }, + "ChatEventType":{ + "type":"string", + "enum":[ + "DISCONNECT", + "MESSAGE", + "EVENT" + ] + }, "ChatMessage":{ "type":"structure", "required":[ @@ -4690,6 +5177,10 @@ "PhoneNumberStatus":{ "shape":"PhoneNumberStatus", "documentation":"

The status of the phone number.

  • CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.

  • IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.

  • FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.

You will not be billed for the phone number during the 1-day period if number claiming fails.

" + }, + "SourcePhoneNumberArn":{ + "shape":"ARN", + "documentation":"

The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.

" } }, "documentation":"

Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.

" @@ -4712,6 +5203,20 @@ "max":10, "min":1 }, + "ConnectionData":{ + "type":"structure", + "members":{ + "Attendee":{ + "shape":"Attendee", + "documentation":"

The attendee information, including attendee ID and join token.

" + }, + "Meeting":{ + "shape":"Meeting", + "documentation":"

A meeting created using the Amazon Chime SDK.

" + } + }, + "documentation":"

Information required to join the call.

" + }, "Contact":{ "type":"structure", "members":{ @@ -5101,6 +5606,11 @@ "max":1024, "min":1 }, + "ContentType":{ + "type":"string", + "max":255, + "min":1 + }, "ControlPlaneTagFilter":{ "type":"structure", "members":{ @@ -6418,6 +6928,15 @@ "type":"list", "member":{"shape":"CurrentMetric"} }, + "DataSetId":{ + "type":"string", + "max":255, + "min":1 + }, + "DataSetIds":{ + "type":"list", + "member":{"shape":"DataSetId"} + }, "DateReference":{ "type":"structure", "members":{ @@ -7703,6 +8222,11 @@ "min":1, "pattern":"(^[\\S].*[\\S]$)|(^[\\S]$)" }, + "DestinationId":{ + "type":"string", + "max":255, + "min":1 + }, "DestinationNotAllowedException":{ "type":"structure", "members":{ @@ -7759,6 +8283,29 @@ ] }, "DirectoryUserId":{"type":"string"}, + "DisassociateAnalyticsDataSetRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "DataSetId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "DataSetId":{ + "shape":"DataSetId", + "documentation":"

The identifier of the dataset to remove.

" + }, + "TargetAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

" + } + } + }, "DisassociateApprovedOriginRequest":{ "type":"structure", "required":[ @@ -7797,6 +8344,39 @@ } } }, + "DisassociateFlowRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "ResourceId", + "ResourceType" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "ResourceId":{ + "shape":"ARN", + "documentation":"

The identifier of the resource.

", + "location":"uri", + "locationName":"ResourceId" + }, + "ResourceType":{ + "shape":"FlowAssociationResourceType", + "documentation":"

A valid resource type.

", + "location":"uri", + "locationName":"ResourceType" + } + } + }, + "DisassociateFlowResponse":{ + "type":"structure", + "members":{ + } + }, "DisassociateInstanceStorageConfigRequest":{ "type":"structure", "required":[ @@ -8143,6 +8723,24 @@ "CONTACT_FLOW" ] }, + "ErrorResult":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"String", + "documentation":"

The error code.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The corresponding error message for the error code.

" + } + }, + "documentation":"

This API is in preview release for Amazon Connect and is subject to change.

List of errors for dataset association failures.

" + }, + "ErrorResults":{ + "type":"list", + "member":{"shape":"ErrorResult"} + }, "Evaluation":{ "type":"structure", "required":[ @@ -9011,6 +9609,7 @@ "enum":[ "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", + "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", @@ -9100,6 +9699,10 @@ "max":5, "min":1 }, + "FlowAssociationResourceType":{ + "type":"string", + "enum":["SMS_PHONE_NUMBER"] + }, "FlowAssociationSummary":{ "type":"structure", "members":{ @@ -9301,6 +9904,51 @@ } } }, + "GetFlowAssociationRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "ResourceId", + "ResourceType" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "ResourceId":{ + "shape":"ARN", + "documentation":"

The identifier of the resource.

", + "location":"uri", + "locationName":"ResourceId" + }, + "ResourceType":{ + "shape":"FlowAssociationResourceType", + "documentation":"

A valid resource type.

", + "location":"uri", + "locationName":"ResourceType" + } + } + }, + "GetFlowAssociationResponse":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"ARN", + "documentation":"

The identifier of the resource.

" + }, + "FlowId":{ + "shape":"ARN", + "documentation":"

The identifier of the flow.

" + }, + "ResourceType":{ + "shape":"FlowAssociationResourceType", + "documentation":"

A valid resource type.

" + } + } + }, "GetMetricDataRequest":{ "type":"structure", "required":[ @@ -9389,15 +10037,15 @@ }, "Filters":{ "shape":"FiltersV2List", - "documentation":"

The filters to apply to returned metrics. You can filter on the following resources:

  • Queues

  • Routing profiles

  • Agents

  • Channels

  • User hierarchy groups

  • Feature

At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.

To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.

Note the following limits:

  • Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | FEATURE

  • Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.

    contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.

" + "documentation":"

The filters to apply to returned metrics. You can filter on the following resources:

  • Queues

  • Routing profiles

  • Agents

  • Channels

  • User hierarchy groups

  • Feature

At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.

To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.

Note the following limits:

  • Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | FEATURE | contact/segmentAttributes/connect:Subtype

  • Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.

    contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.

    connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.

" }, "Groupings":{ "shape":"GroupingsV2", - "documentation":"

The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.

If no grouping is specified, a summary of all metrics is returned.

Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE

" + "documentation":"

The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.

If no grouping is specified, a summary of all metrics is returned.

Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE, contact/segmentAttributes/connect:Subtype

" }, "Metrics":{ "shape":"MetricsV2", - "documentation":"

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.

ABANDONMENT_RATE

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_ADHERENT_TIME

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_NON_RESPONSE

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

AGENT_OCCUPANCY

Unit: Percentage

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

AGENT_SCHEDULE_ADHERENCE

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_SCHEDULED_TIME

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_ABANDON_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_AFTER_CONTACT_WORK_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

Feature is a valid filter but not a valid grouping.
AVG_AGENT_CONNECTING_TIME

Unit: Seconds

Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

The Negate key in Metric Level Filters is not applicable for this metric.
AVG_CONTACT_DURATION

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

Feature is a valid filter but not a valid grouping.
AVG_CONVERSATION_DURATION

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_GREETING_TIME_AGENT

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_HANDLE_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

Feature is a valid filter but not a valid grouping.
AVG_HOLD_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

Feature is a valid filter but not a valid grouping.
AVG_HOLD_TIME_ALL_CONTACTS

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_HOLDS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

Feature is a valid filter but not a valid grouping.
AVG_INTERACTION_AND_HOLD_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_INTERACTION_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

Feature is a valid filter but not a valid grouping.
AVG_INTERRUPTIONS_AGENT

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_INTERRUPTION_TIME_AGENT

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_NON_TALK_TIME

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_QUEUE_ANSWER_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

Feature is a valid filter but not a valid grouping.
AVG_RESOLUTION_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile

AVG_TALK_TIME

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_TALK_TIME_AGENT

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_TALK_TIME_CUSTOMER

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_ABANDONED

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_CREATED

Unit: Count

Valid metric filter key: INITIATION_METHOD

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

Feature is a valid filter but not a valid grouping.
CONTACTS_HANDLED

Unit: Count

Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

Feature is a valid filter but not a valid grouping.
CONTACTS_HOLD_ABANDONS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_QUEUED

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_RESOLVED_IN_X

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile

Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").

CONTACTS_TRANSFERRED_OUT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

Feature is a valid filter but not a valid grouping.
CONTACTS_TRANSFERRED_OUT_BY_AGENT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

MAX_QUEUED_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

PERCENT_NON_TALK_TIME

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

PERCENT_TALK_TIME

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

PERCENT_TALK_TIME_AGENT

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

PERCENT_TALK_TIME_CUSTOMER

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").

SUM_CONTACTS_ANSWERED_IN_X

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").

SUM_CONTACTS_ABANDONED_IN_X

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").

SUM_CONTACTS_DISCONNECTED

Valid metric filter key: DISCONNECT_REASON

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile

SUM_RETRY_CALLBACK_ATTEMPTS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile

" + "documentation":"

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.

ABANDONMENT_RATE

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

AGENT_ADHERENT_TIME

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_ANSWER_RATE

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_NON_ADHERENT_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_NON_RESPONSE

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

AGENT_OCCUPANCY

Unit: Percentage

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

AGENT_SCHEDULE_ADHERENCE

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_SCHEDULED_TIME

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_ABANDON_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

AVG_AFTER_CONTACT_WORK_TIME

Unit: Seconds

Valid metric filter key: INITIATION_METHOD

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

Feature is a valid filter but not a valid grouping.
AVG_AGENT_CONNECTING_TIME

Unit: Seconds

Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

The Negate key in Metric Level Filters is not applicable for this metric.
AVG_CONTACT_DURATION

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

Feature is a valid filter but not a valid grouping.
AVG_CONVERSATION_DURATION

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

AVG_GREETING_TIME_AGENT

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

AVG_HANDLE_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

Feature is a valid filter but not a valid grouping.
AVG_HOLD_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

Feature is a valid filter but not a valid grouping.
AVG_HOLD_TIME_ALL_CONTACTS

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

AVG_HOLDS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

Feature is a valid filter but not a valid grouping.
AVG_INTERACTION_AND_HOLD_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

AVG_INTERACTION_TIME

Unit: Seconds

Valid metric filter key: INITIATION_METHOD

Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

Feature is a valid filter but not a valid grouping.
AVG_INTERRUPTIONS_AGENT

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

AVG_INTERRUPTION_TIME_AGENT

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

AVG_NON_TALK_TIME

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

AVG_QUEUE_ANSWER_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

Feature is a valid filter but not a valid grouping.
AVG_RESOLUTION_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

AVG_TALK_TIME

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

AVG_TALK_TIME_AGENT

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

AVG_TALK_TIME_CUSTOMER

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

CONTACTS_ABANDONED

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

CONTACTS_CREATED

Unit: Count

Valid metric filter key: INITIATION_METHOD

Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

Feature is a valid filter but not a valid grouping.
CONTACTS_HANDLED

Unit: Count

Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

Feature is a valid filter but not a valid grouping.
CONTACTS_HOLD_ABANDONS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

CONTACTS_ON_HOLD_AGENT_DISCONNECT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_PUT_ON_HOLD

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_TRANSFERRED_OUT_EXTERNAL

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_TRANSFERRED_OUT_INTERNAL

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_QUEUED

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

CONTACTS_RESOLVED_IN_X

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").

CONTACTS_TRANSFERRED_OUT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

Feature is a valid filter but not a valid grouping.
CONTACTS_TRANSFERRED_OUT_BY_AGENT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

MAX_QUEUED_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

PERCENT_NON_TALK_TIME

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

PERCENT_TALK_TIME

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

PERCENT_TALK_TIME_AGENT

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

PERCENT_TALK_TIME_CUSTOMER

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").

SUM_AFTER_CONTACT_WORK_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_CONNECTING_TIME_AGENT

Unit: Seconds

Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

The Negate key in Metric Level Filters is not applicable for this metric.
SUM_CONTACT_FLOW_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_CONTACT_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_CONTACTS_ANSWERED_IN_X

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").

SUM_CONTACTS_ABANDONED_IN_X

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").

SUM_CONTACTS_DISCONNECTED

Valid metric filter key: DISCONNECT_REASON

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

SUM_ERROR_STATUS_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_HANDLE_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_HOLD_TIME

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_IDLE_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

SUM_INTERACTION_AND_HOLD_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_INTERACTION_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_NON_PRODUCTIVE_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

SUM_ONLINE_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

SUM_RETRY_CALLBACK_ATTEMPTS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

" }, "NextToken":{ "shape":"NextToken2500", @@ -10142,6 +10790,49 @@ "error":{"httpStatusCode":409}, "exception":true }, + "ImportPhoneNumberRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "SourcePhoneNumberArn" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

" + }, + "SourcePhoneNumberArn":{ + "shape":"ARN", + "documentation":"

The claimed phone number ARN being imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number to import from Amazon Pinpoint.

" + }, + "PhoneNumberDescription":{ + "shape":"PhoneNumberDescription", + "documentation":"

The description of the phone number.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

", + "idempotencyToken":true + } + } + }, + "ImportPhoneNumberResponse":{ + "type":"structure", + "members":{ + "PhoneNumberId":{ + "shape":"PhoneNumberId", + "documentation":"

A unique identifier for the phone number.

" + }, + "PhoneNumberArn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the phone number.

" + } + } + }, "InboundCallsEnabled":{"type":"boolean"}, "Instance":{ "type":"structure", @@ -10508,6 +11199,10 @@ "type":"list", "member":{"shape":"InvisibleFieldInfo"} }, + "JoinToken":{ + "type":"string", + "sensitive":true + }, "KeyId":{ "type":"string", "max":128, @@ -10677,7 +11372,7 @@ } } }, - "ListApprovedOriginsRequest":{ + "ListAnalyticsDataAssociationsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ @@ -10687,6 +11382,12 @@ "location":"uri", "locationName":"InstanceId" }, + "DataSetId":{ + "shape":"DataSetId", + "documentation":"

The identifier of the dataset to get the association status.

", + "location":"querystring", + "locationName":"DataSetId" + }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", @@ -10694,20 +11395,19 @@ "locationName":"nextToken" }, "MaxResults":{ - "shape":"MaxResult25", + "shape":"MaxResult1000", "documentation":"

The maximum number of results to return per page.

", - "box":true, "location":"querystring", "locationName":"maxResults" } } }, - "ListApprovedOriginsResponse":{ + "ListAnalyticsDataAssociationsResponse":{ "type":"structure", "members":{ - "Origins":{ - "shape":"OriginsList", - "documentation":"

The approved origins.

" + "Results":{ + "shape":"AnalyticsDataAssociationResults", + "documentation":"

An array of successful results: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn. This is a paginated API, so nextToken is given if there are more results to be returned.

" }, "NextToken":{ "shape":"NextToken", @@ -10715,12 +11415,9 @@ } } }, - "ListBotsRequest":{ + "ListApprovedOriginsRequest":{ "type":"structure", - "required":[ - "InstanceId", - "LexVersion" - ], + "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", @@ -10740,21 +11437,15 @@ "box":true, "location":"querystring", "locationName":"maxResults" - }, - "LexVersion":{ - "shape":"LexVersion", - "documentation":"

The version of Amazon Lex or Amazon Lex V2.

", - "location":"querystring", - "locationName":"lexVersion" } } }, - "ListBotsResponse":{ + "ListApprovedOriginsResponse":{ "type":"structure", "members":{ - "LexBots":{ - "shape":"LexBotConfigList", - "documentation":"

The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

" + "Origins":{ + "shape":"OriginsList", + "documentation":"

The approved origins.

" }, "NextToken":{ "shape":"NextToken", @@ -10762,7 +11453,54 @@ } } }, - "ListContactEvaluationsRequest":{ + "ListBotsRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "LexVersion" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult25", + "documentation":"

The maximum number of results to return per page.

", + "box":true, + "location":"querystring", + "locationName":"maxResults" + }, + "LexVersion":{ + "shape":"LexVersion", + "documentation":"

The version of Amazon Lex or Amazon Lex V2.

", + "location":"querystring", + "locationName":"lexVersion" + } + } + }, + "ListBotsResponse":{ + "type":"structure", + "members":{ + "LexBots":{ + "shape":"LexBotConfigList", + "documentation":"

The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListContactEvaluationsRequest":{ "type":"structure", "required":[ "InstanceId", @@ -11066,6 +11804,50 @@ "type":"string", "enum":["VOICE_PHONE_NUMBER"] }, + "ListFlowAssociationsRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "ResourceType":{ + "shape":"ListFlowAssociationResourceType", + "documentation":"

A valid resource type.

", + "location":"querystring", + "locationName":"ResourceType" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"

The maximum number of results to return per page.

", + "box":true, + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListFlowAssociationsResponse":{ + "type":"structure", + "members":{ + "FlowAssociationSummaryList":{ + "shape":"FlowAssociationSummaryList", + "documentation":"

Summary of flow associations.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, "ListHoursOfOperationsRequest":{ "type":"structure", "required":["InstanceId"], @@ -11424,6 +12206,14 @@ "InstanceId":{ "shape":"InstanceId", "documentation":"

The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

" + }, + "PhoneNumberDescription":{ + "shape":"PhoneNumberDescription", + "documentation":"

The description of the phone number.

" + }, + "SourcePhoneNumberArn":{ + "shape":"ARN", + "documentation":"

The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.

" } }, "documentation":"

Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.

" @@ -11640,7 +12430,7 @@ }, "QuickConnectTypes":{ "shape":"QuickConnectTypes", - "documentation":"

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

", + "documentation":"

The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

", "location":"querystring", "locationName":"QuickConnectTypes" } @@ -11659,6 +12449,71 @@ } } }, + "ListRealtimeContactAnalysisSegmentsV2Request":{ + "type":"structure", + "required":[ + "InstanceId", + "ContactId", + "OutputType", + "SegmentTypes" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "ContactId":{ + "shape":"ContactId", + "documentation":"

The identifier of the contact in this instance of Amazon Connect.

", + "location":"uri", + "locationName":"ContactId" + }, + "MaxResults":{ + "shape":"MaxResult100", + "documentation":"

The maximum number of results to return per page.

" + }, + "NextToken":{ + "shape":"LargeNextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

" + }, + "OutputType":{ + "shape":"RealTimeContactAnalysisOutputType", + "documentation":"

The Contact Lens output type to be returned.

" + }, + "SegmentTypes":{ + "shape":"RealTimeContactAnalysisSegmentTypes", + "documentation":"

Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.

" + } + } + }, + "ListRealtimeContactAnalysisSegmentsV2Response":{ + "type":"structure", + "required":[ + "Channel", + "Status", + "Segments" + ], + "members":{ + "Channel":{ + "shape":"RealTimeContactAnalysisSupportedChannel", + "documentation":"

The channel of the contact. Voice will not be returned.

" + }, + "Status":{ + "shape":"RealTimeContactAnalysisStatus", + "documentation":"

Status of real-time contact analysis.

" + }, + "Segments":{ + "shape":"RealtimeContactAnalysisSegments", + "documentation":"

An analyzed transcript or category.

" + }, + "NextToken":{ + "shape":"LargeNextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, "ListRoutingProfileQueuesRequest":{ "type":"structure", "required":[ @@ -12424,6 +13279,73 @@ }, "documentation":"

Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.

" }, + "MediaPlacement":{ + "type":"structure", + "members":{ + "AudioHostUrl":{ + "shape":"URI", + "documentation":"

The audio host URL.

" + }, + "AudioFallbackUrl":{ + "shape":"URI", + "documentation":"

The audio fallback URL.

" + }, + "SignalingUrl":{ + "shape":"URI", + "documentation":"

The signaling URL.

" + }, + "TurnControlUrl":{ + "shape":"URI", + "documentation":"

The turn control URL.

" + }, + "EventIngestionUrl":{ + "shape":"URI", + "documentation":"

The event ingestion URL to which you send client meeting events.

" + } + }, + "documentation":"

A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.

" + }, + "MediaRegion":{"type":"string"}, + "Meeting":{ + "type":"structure", + "members":{ + "MediaRegion":{ + "shape":"MediaRegion", + "documentation":"

The Amazon Web Services Region in which you create the meeting.

" + }, + "MediaPlacement":{ + "shape":"MediaPlacement", + "documentation":"

The media placement for the meeting.

" + }, + "MeetingFeatures":{ + "shape":"MeetingFeaturesConfiguration", + "documentation":"

The configuration settings of the features available to a meeting.

" + }, + "MeetingId":{ + "shape":"MeetingId", + "documentation":"

The Amazon Chime SDK meeting ID.

" + } + }, + "documentation":"

A meeting created using the Amazon Chime SDK.

" + }, + "MeetingFeatureStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "UNAVAILABLE" + ] + }, + "MeetingFeaturesConfiguration":{ + "type":"structure", + "members":{ + "Audio":{ + "shape":"AudioFeatures", + "documentation":"

The configuration settings for the audio features available to a meeting.

" + } + }, + "documentation":"

The configuration settings of the features available to a meeting.

" + }, + "MeetingId":{"type":"string"}, "Message":{"type":"string"}, "MetricDataCollectionsV2":{ "type":"list", @@ -12608,6 +13530,23 @@ "max":128, "min":1 }, + "NewChatCreated":{"type":"boolean"}, + "NewSessionDetails":{ + "type":"structure", + "members":{ + "SupportedMessagingContentTypes":{ + "shape":"SupportedMessagingContentTypes", + "documentation":"

The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].

" + }, + "ParticipantDetails":{"shape":"ParticipantDetails"}, + "Attributes":{ + "shape":"Attributes", + "documentation":"

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

" + }, + "StreamingConfiguration":{"shape":"ChatStreamingConfiguration"} + }, + "documentation":"

Payload of chat properties to apply when starting a new contact.

" + }, "NextToken":{"type":"string"}, "NextToken2500":{ "type":"string", @@ -12718,11 +13657,30 @@ "error":{"httpStatusCode":403}, "exception":true }, + "OutputTypeNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in Contact flow.

", + "error":{"httpStatusCode":404}, + "exception":true + }, "PEM":{ "type":"string", "max":1024, "min":1 }, + "ParticipantCapabilities":{ + "type":"structure", + "members":{ + "Video":{ + "shape":"VideoCapability", + "documentation":"

The configuration having the video sharing capabilities for participants over the call.

" + } + }, + "documentation":"

The configuration for the allowed capabilities for participants present over the call.

" + }, "ParticipantDetails":{ "type":"structure", "required":["DisplayName"], @@ -13199,7 +14157,8 @@ "UIFN", "SHARED", "THIRD_PARTY_TF", - "THIRD_PARTY_DID" + "THIRD_PARTY_DID", + "SHORT_CODE" ] }, "PhoneNumberTypes":{ @@ -13679,162 +14638,566 @@ "shape":"QuickConnectName", "documentation":"

The name of the quick connect.

" }, - "Description":{ - "shape":"QuickConnectDescription", - "documentation":"

The description.

" + "Description":{ + "shape":"QuickConnectDescription", + "documentation":"

The description.

" + }, + "QuickConnectConfig":{ + "shape":"QuickConnectConfig", + "documentation":"

Contains information about the quick connect.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

The timestamp when this resource was last modified.

" + }, + "LastModifiedRegion":{ + "shape":"RegionName", + "documentation":"

The Amazon Web Services Region where this resource was last modified.

" + } + }, + "documentation":"

Contains information about a quick connect.

" + }, + "QuickConnectConfig":{ + "type":"structure", + "required":["QuickConnectType"], + "members":{ + "QuickConnectType":{ + "shape":"QuickConnectType", + "documentation":"

The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

" + }, + "UserConfig":{ + "shape":"UserQuickConnectConfig", + "documentation":"

The user configuration. This is required only if QuickConnectType is USER.

" + }, + "QueueConfig":{ + "shape":"QueueQuickConnectConfig", + "documentation":"

The queue configuration. This is required only if QuickConnectType is QUEUE.

" + }, + "PhoneConfig":{ + "shape":"PhoneNumberQuickConnectConfig", + "documentation":"

The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

" + } + }, + "documentation":"

Contains configuration settings for a quick connect.

" + }, + "QuickConnectDescription":{ + "type":"string", + "max":250, + "min":1 + }, + "QuickConnectId":{"type":"string"}, + "QuickConnectName":{ + "type":"string", + "max":127, + "min":1 + }, + "QuickConnectSearchConditionList":{ + "type":"list", + "member":{"shape":"QuickConnectSearchCriteria"} + }, + "QuickConnectSearchCriteria":{ + "type":"structure", + "members":{ + "OrConditions":{ + "shape":"QuickConnectSearchConditionList", + "documentation":"

A list of conditions which would be applied together with an OR condition.

" + }, + "AndConditions":{ + "shape":"QuickConnectSearchConditionList", + "documentation":"

A list of conditions which would be applied together with an AND condition.

" + }, + "StringCondition":{ + "shape":"StringCondition", + "documentation":"

A leaf node condition which can be used to specify a string condition.

The currently supported values for FieldName are name, description, and resourceID.

" + } + }, + "documentation":"

The search criteria to be used to return quick connects.

" + }, + "QuickConnectSearchFilter":{ + "type":"structure", + "members":{ + "TagFilter":{"shape":"ControlPlaneTagFilter"} + }, + "documentation":"

Filters to be applied to search results.

" + }, + "QuickConnectSearchSummaryList":{ + "type":"list", + "member":{"shape":"QuickConnect"} + }, + "QuickConnectSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"QuickConnectId", + "documentation":"

The identifier for the quick connect.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the quick connect.

" + }, + "Name":{ + "shape":"QuickConnectName", + "documentation":"

The name of the quick connect.

" + }, + "QuickConnectType":{ + "shape":"QuickConnectType", + "documentation":"

The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

The timestamp when this resource was last modified.

" + }, + "LastModifiedRegion":{ + "shape":"RegionName", + "documentation":"

The Amazon Web Services Region where this resource was last modified.

" + } + }, + "documentation":"

Contains summary information about a quick connect.

" + }, + "QuickConnectSummaryList":{ + "type":"list", + "member":{"shape":"QuickConnectSummary"} + }, + "QuickConnectType":{ + "type":"string", + "enum":[ + "USER", + "QUEUE", + "PHONE_NUMBER" + ] + }, + "QuickConnectTypes":{ + "type":"list", + "member":{"shape":"QuickConnectType"}, + "max":3 + }, + "QuickConnectsList":{ + "type":"list", + "member":{"shape":"QuickConnectId"}, + "max":50, + "min":1 + }, + "ReadOnlyFieldInfo":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"TaskTemplateFieldIdentifier", + "documentation":"

Identifier of the read-only field.

" + } + }, + "documentation":"

Indicates a field that is read-only to an agent.

" + }, + "ReadOnlyTaskTemplateFields":{ + "type":"list", + "member":{"shape":"ReadOnlyFieldInfo"} + }, + "RealTimeContactAnalysisAttachment":{ + "type":"structure", + "required":[ + "AttachmentName", + "AttachmentId" + ], + "members":{ + "AttachmentName":{ + "shape":"AttachmentName", + "documentation":"

A case-sensitive name of the attachment being uploaded. Can be redacted.

" + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

" + }, + "AttachmentId":{ + "shape":"ArtifactId", + "documentation":"

A unique identifier for the attachment.

" + }, + "Status":{ + "shape":"ArtifactStatus", + "documentation":"

Status of the attachment.

" + } + }, + "documentation":"

Object that describes attached file.

" + }, + "RealTimeContactAnalysisAttachments":{ + "type":"list", + "member":{"shape":"RealTimeContactAnalysisAttachment"}, + "max":10 + }, + "RealTimeContactAnalysisCategoryDetails":{ + "type":"structure", + "required":["PointsOfInterest"], + "members":{ + "PointsOfInterest":{ + "shape":"RealTimeContactAnalysisPointsOfInterest", + "documentation":"

List of PointOfInterest - objects describing a single match of a rule.

" + } + }, + "documentation":"

Provides information about the category rule that was matched.

" + }, + "RealTimeContactAnalysisCategoryName":{ + "type":"string", + "max":256, + "min":1 + }, + "RealTimeContactAnalysisCharacterInterval":{ + "type":"structure", + "required":[ + "BeginOffsetChar", + "EndOffsetChar" + ], + "members":{ + "BeginOffsetChar":{ + "shape":"RealTimeContactAnalysisOffset", + "documentation":"

The beginning of the character interval.

" + }, + "EndOffsetChar":{ + "shape":"RealTimeContactAnalysisOffset", + "documentation":"

The end of the character interval.

" + } + }, + "documentation":"

Begin and end offsets for a part of text.

" + }, + "RealTimeContactAnalysisCharacterIntervals":{ + "type":"list", + "member":{"shape":"RealTimeContactAnalysisCharacterInterval"} + }, + "RealTimeContactAnalysisContentType":{ + "type":"string", + "max":256, + "min":1 + }, + "RealTimeContactAnalysisEventType":{ + "type":"string", + "max":128, + "min":1 + }, + "RealTimeContactAnalysisId256":{ + "type":"string", + "max":256, + "min":1 + }, + "RealTimeContactAnalysisIssueDetected":{ + "type":"structure", + "required":["TranscriptItems"], + "members":{ + "TranscriptItems":{ + "shape":"RealTimeContactAnalysisTranscriptItemsWithContent", + "documentation":"

List of the transcript items (segments) that are associated with a given issue.

" + } + }, + "documentation":"

Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.

" + }, + "RealTimeContactAnalysisIssuesDetected":{ + "type":"list", + "member":{"shape":"RealTimeContactAnalysisIssueDetected"} + }, + "RealTimeContactAnalysisMatchedDetails":{ + "type":"map", + "key":{"shape":"RealTimeContactAnalysisCategoryName"}, + "value":{"shape":"RealTimeContactAnalysisCategoryDetails"}, + "max":150, + "min":0 + }, + "RealTimeContactAnalysisOffset":{ + "type":"integer", + "min":0 + }, + "RealTimeContactAnalysisOutputType":{ + "type":"string", + "enum":[ + "Raw", + "Redacted" + ] + }, + "RealTimeContactAnalysisPointOfInterest":{ + "type":"structure", + "members":{ + "TranscriptItems":{ + "shape":"RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets", + "documentation":"

List of the transcript items (segments) that are associated with a given point of interest.

" + } + }, + "documentation":"

The section of the contact transcript segment that category rule was detected.

" + }, + "RealTimeContactAnalysisPointsOfInterest":{ + "type":"list", + "member":{"shape":"RealTimeContactAnalysisPointOfInterest"}, + "max":5, + "min":0 + }, + "RealTimeContactAnalysisSegmentAttachments":{ + "type":"structure", + "required":[ + "Id", + "ParticipantId", + "ParticipantRole", + "Attachments", + "Time" + ], + "members":{ + "Id":{ + "shape":"RealTimeContactAnalysisId256", + "documentation":"

The identifier of the segment.

" + }, + "ParticipantId":{ + "shape":"ParticipantId", + "documentation":"

The identifier of the participant.

" + }, + "ParticipantRole":{ + "shape":"ParticipantRole", + "documentation":"

The role of the participant. For example, is it a customer, agent, or system.

" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

The display name of the participant. Can be redacted.

" + }, + "Attachments":{ + "shape":"RealTimeContactAnalysisAttachments", + "documentation":"

List of objects describing an individual attachment.

" + }, + "Time":{ + "shape":"RealTimeContactAnalysisTimeData", + "documentation":"

Field describing the time of the event. It can have different representations of time.

" + } + }, + "documentation":"

Segment containing list of attachments.

" + }, + "RealTimeContactAnalysisSegmentCategories":{ + "type":"structure", + "required":["MatchedDetails"], + "members":{ + "MatchedDetails":{ + "shape":"RealTimeContactAnalysisMatchedDetails", + "documentation":"

Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.

" + } + }, + "documentation":"

The matched category rules.

" + }, + "RealTimeContactAnalysisSegmentEvent":{ + "type":"structure", + "required":[ + "Id", + "EventType", + "Time" + ], + "members":{ + "Id":{ + "shape":"RealTimeContactAnalysisId256", + "documentation":"

The identifier of the contact event.

" + }, + "ParticipantId":{ + "shape":"ParticipantId", + "documentation":"

The identifier of the participant.

" }, - "QuickConnectConfig":{ - "shape":"QuickConnectConfig", - "documentation":"

Contains information about the quick connect.

" + "ParticipantRole":{ + "shape":"ParticipantRole", + "documentation":"

The role of the participant. For example, is it a customer, agent, or system.

" }, - "Tags":{ - "shape":"TagMap", - "documentation":"

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

The display name of the participant. Can be redacted.

" }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when this resource was last modified.

" + "EventType":{ + "shape":"RealTimeContactAnalysisEventType", + "documentation":"

Type of the event. For example, application/vnd.amazonaws.connect.event.participant.left.

" }, - "LastModifiedRegion":{ - "shape":"RegionName", - "documentation":"

The Amazon Web Services Region where this resource was last modified.

" + "Time":{ + "shape":"RealTimeContactAnalysisTimeData", + "documentation":"

Field describing the time of the event. It can have different representations of time.

" } }, - "documentation":"

Contains information about a quick connect.

" + "documentation":"

Segment type describing a contact event.

" }, - "QuickConnectConfig":{ + "RealTimeContactAnalysisSegmentIssues":{ "type":"structure", - "required":["QuickConnectType"], + "required":["IssuesDetected"], "members":{ - "QuickConnectType":{ - "shape":"QuickConnectType", - "documentation":"

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

" + "IssuesDetected":{ + "shape":"RealTimeContactAnalysisIssuesDetected", + "documentation":"

List of the issues detected.

" + } + }, + "documentation":"

Segment type containing a list of detected issues.

" + }, + "RealTimeContactAnalysisSegmentTranscript":{ + "type":"structure", + "required":[ + "Id", + "ParticipantId", + "ParticipantRole", + "Content", + "Time" + ], + "members":{ + "Id":{ + "shape":"RealTimeContactAnalysisId256", + "documentation":"

The identifier of the transcript.

" }, - "UserConfig":{ - "shape":"UserQuickConnectConfig", - "documentation":"

The user configuration. This is required only if QuickConnectType is USER.

" + "ParticipantId":{ + "shape":"ParticipantId", + "documentation":"

The identifier of the participant.

" }, - "QueueConfig":{ - "shape":"QueueQuickConnectConfig", - "documentation":"

The queue configuration. This is required only if QuickConnectType is QUEUE.

" + "ParticipantRole":{ + "shape":"ParticipantRole", + "documentation":"

The role of the participant. For example, is it a customer, agent, or system.

" }, - "PhoneConfig":{ - "shape":"PhoneNumberQuickConnectConfig", - "documentation":"

The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

" + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

The display name of the participant.

" + }, + "Content":{ + "shape":"RealTimeContactAnalysisTranscriptContent", + "documentation":"

The content of the transcript. Can be redacted.

" + }, + "ContentType":{ + "shape":"RealTimeContactAnalysisContentType", + "documentation":"

The type of content of the item. For example, text/plain.

" + }, + "Time":{ + "shape":"RealTimeContactAnalysisTimeData", + "documentation":"

Field describing the time of the event. It can have different representations of time.

" + }, + "Redaction":{ + "shape":"RealTimeContactAnalysisTranscriptItemRedaction", + "documentation":"

Object describing redaction that was applied to the transcript. If transcript has the field it means part of the transcript was redacted.

" + }, + "Sentiment":{ + "shape":"RealTimeContactAnalysisSentimentLabel", + "documentation":"

The sentiment detected for this piece of transcript.

" } }, - "documentation":"

Contains configuration settings for a quick connect.

" + "documentation":"

The analyzed transcript segment.

" }, - "QuickConnectDescription":{ + "RealTimeContactAnalysisSegmentType":{ "type":"string", - "max":250, - "min":1 + "enum":[ + "Transcript", + "Categories", + "Issues", + "Event", + "Attachments" + ] }, - "QuickConnectId":{"type":"string"}, - "QuickConnectName":{ + "RealTimeContactAnalysisSegmentTypes":{ + "type":"list", + "member":{"shape":"RealTimeContactAnalysisSegmentType"}, + "max":5 + }, + "RealTimeContactAnalysisSentimentLabel":{ "type":"string", - "max":127, - "min":1 + "enum":[ + "POSITIVE", + "NEGATIVE", + "NEUTRAL" + ] }, - "QuickConnectSearchConditionList":{ - "type":"list", - "member":{"shape":"QuickConnectSearchCriteria"} + "RealTimeContactAnalysisStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "FAILED", + "COMPLETED" + ] }, - "QuickConnectSearchCriteria":{ + "RealTimeContactAnalysisSupportedChannel":{ + "type":"string", + "enum":[ + "VOICE", + "CHAT" + ] + }, + "RealTimeContactAnalysisTimeData":{ "type":"structure", "members":{ - "OrConditions":{ - "shape":"QuickConnectSearchConditionList", - "documentation":"

A list of conditions which would be applied together with an OR condition.

" - }, - "AndConditions":{ - "shape":"QuickConnectSearchConditionList", - "documentation":"

A list of conditions which would be applied together with an AND condition.

" - }, - "StringCondition":{ - "shape":"StringCondition", - "documentation":"

A leaf node condition which can be used to specify a string condition.

The currently supported values for FieldName are name, description, and resourceID.

" + "AbsoluteTime":{ + "shape":"RealTimeContactAnalysisTimeInstant", + "documentation":"

Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

" } }, - "documentation":"

The search criteria to be used to return quick connects.

" + "documentation":"

Object describing time with which the segment is associated. It can have different representations of time. Currently supported: absoluteTime

", + "union":true }, - "QuickConnectSearchFilter":{ + "RealTimeContactAnalysisTimeInstant":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "RealTimeContactAnalysisTranscriptContent":{ + "type":"string", + "max":16384, + "min":1 + }, + "RealTimeContactAnalysisTranscriptItemRedaction":{ "type":"structure", "members":{ - "TagFilter":{"shape":"ControlPlaneTagFilter"} + "CharacterOffsets":{ + "shape":"RealTimeContactAnalysisCharacterIntervals", + "documentation":"

List of character intervals each describing a part of the text that was redacted. For OutputType.Raw, part of the original text that contains data that can be redacted. For OutputType.Redacted, part of the string with redaction tag.

" + } }, - "documentation":"

Filters to be applied to search results.

" + "documentation":"

Object describing redaction applied to the segment.

" }, - "QuickConnectSearchSummaryList":{ - "type":"list", - "member":{"shape":"QuickConnect"} - }, - "QuickConnectSummary":{ + "RealTimeContactAnalysisTranscriptItemWithCharacterOffsets":{ "type":"structure", + "required":["Id"], "members":{ "Id":{ - "shape":"QuickConnectId", - "documentation":"

The identifier for the quick connect.

" - }, - "Arn":{ - "shape":"ARN", - "documentation":"

The Amazon Resource Name (ARN) of the quick connect.

" - }, - "Name":{ - "shape":"QuickConnectName", - "documentation":"

The name of the quick connect.

" + "shape":"RealTimeContactAnalysisId256", + "documentation":"

Transcript identifier. Matches the identifier from one of the TranscriptSegments.

" }, - "QuickConnectType":{ - "shape":"QuickConnectType", - "documentation":"

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when this resource was last modified.

" - }, - "LastModifiedRegion":{ - "shape":"RegionName", - "documentation":"

The Amazon Web Services Region where this resource was last modified.

" + "CharacterOffsets":{ + "shape":"RealTimeContactAnalysisCharacterInterval", + "documentation":"

List of character intervals within transcript content/text.

" } }, - "documentation":"

Contains summary information about a quick connect.

" - }, - "QuickConnectSummaryList":{ - "type":"list", - "member":{"shape":"QuickConnectSummary"} + "documentation":"

Transcript representation containing Id and list of character intervals that are associated with analysis data. For example, this object within a RealTimeContactAnalysisPointOfInterest in Category.MatchedDetails would have character interval describing part of the text that matched category.

" }, - "QuickConnectType":{ - "type":"string", - "enum":[ - "USER", - "QUEUE", - "PHONE_NUMBER" - ] + "RealTimeContactAnalysisTranscriptItemWithContent":{ + "type":"structure", + "required":["Id"], + "members":{ + "Content":{ + "shape":"RealTimeContactAnalysisTranscriptContent", + "documentation":"

Part of the transcript content that contains identified issue. Can be redacted

" + }, + "Id":{ + "shape":"RealTimeContactAnalysisId256", + "documentation":"

Transcript identifier. Matches the identifier from one of the TranscriptSegments.

" + }, + "CharacterOffsets":{"shape":"RealTimeContactAnalysisCharacterInterval"} + }, + "documentation":"

Transcript representation containing Id, Content and list of character intervals that are associated with analysis data. For example, this object within an issue detected would describe both content that contains identified issue and intervals where that content is taken from.

" }, - "QuickConnectTypes":{ + "RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets":{ "type":"list", - "member":{"shape":"QuickConnectType"}, - "max":3 + "member":{"shape":"RealTimeContactAnalysisTranscriptItemWithCharacterOffsets"}, + "max":10, + "min":0 }, - "QuickConnectsList":{ + "RealTimeContactAnalysisTranscriptItemsWithContent":{ "type":"list", - "member":{"shape":"QuickConnectId"}, - "max":50, - "min":1 + "member":{"shape":"RealTimeContactAnalysisTranscriptItemWithContent"} }, - "ReadOnlyFieldInfo":{ + "RealtimeContactAnalysisSegment":{ "type":"structure", "members":{ - "Id":{ - "shape":"TaskTemplateFieldIdentifier", - "documentation":"

Identifier of the read-only field.

" + "Transcript":{"shape":"RealTimeContactAnalysisSegmentTranscript"}, + "Categories":{"shape":"RealTimeContactAnalysisSegmentCategories"}, + "Issues":{"shape":"RealTimeContactAnalysisSegmentIssues"}, + "Event":{"shape":"RealTimeContactAnalysisSegmentEvent"}, + "Attachments":{ + "shape":"RealTimeContactAnalysisSegmentAttachments", + "documentation":"

The analyzed attachments.

" } }, - "documentation":"

Indicates a field that is read-only to an agent.

" + "documentation":"

An analyzed segment for a real-time analysis session.

", + "union":true }, - "ReadOnlyTaskTemplateFields":{ + "RealtimeContactAnalysisSegments":{ "type":"list", - "member":{"shape":"ReadOnlyFieldInfo"} + "member":{"shape":"RealtimeContactAnalysisSegment"} }, "Reference":{ "type":"structure", @@ -14093,7 +15456,8 @@ "PARTICIPANT", "HIERARCHY_LEVEL", "HIERARCHY_GROUP", - "USER" + "USER", + "PHONE_NUMBER" ] }, "ResourceTypeList":{ @@ -14454,15 +15818,15 @@ }, "EventBridgeAction":{ "shape":"EventBridgeActionDefinition", - "documentation":"

Information about the EventBridge action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

" + "documentation":"

Information about the EventBridge action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

" }, "AssignContactCategoryAction":{ "shape":"AssignContactCategoryActionDefinition", - "documentation":"

Information about the contact category action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

" + "documentation":"

Information about the contact category action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

" }, "SendNotificationAction":{ "shape":"SendNotificationActionDefinition", - "documentation":"

Information about the send notification action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

" + "documentation":"

Information about the send notification action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

" } }, "documentation":"

Information about the action to be performed when a rule is triggered.

" @@ -15243,6 +16607,49 @@ "key":{"shape":"SegmentAttributeName"}, "value":{"shape":"SegmentAttributeValue"} }, + "SendChatIntegrationEventRequest":{ + "type":"structure", + "required":[ + "SourceId", + "DestinationId", + "Event" + ], + "members":{ + "SourceId":{ + "shape":"SourceId", + "documentation":"

External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.

" + }, + "DestinationId":{ + "shape":"DestinationId", + "documentation":"

Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone number destination of inbound SMS messages represented by an Amazon Pinpoint phone number ARN.

" + }, + "Subtype":{ + "shape":"Subtype", + "documentation":"

Classification of a channel. This is used in part to uniquely identify chat.

Valid value: [\"connect:sms\"]

" + }, + "Event":{ + "shape":"ChatEvent", + "documentation":"

Chat integration event payload

" + }, + "NewSessionDetails":{ + "shape":"NewSessionDetails", + "documentation":"

Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.

" + } + } + }, + "SendChatIntegrationEventResponse":{ + "type":"structure", + "members":{ + "InitialContactId":{ + "shape":"ContactId", + "documentation":"

Identifier of chat contact used to handle integration event. This may be null if the integration event is not valid without an already existing chat contact.

" + }, + "NewChatCreated":{ + "shape":"NewChatCreated", + "documentation":"

Whether handling the integration event resulted in creating a new chat or acting on existing chat.

" + } + } + }, "SendNotificationActionDefinition":{ "type":"structure", "required":[ @@ -15370,6 +16777,11 @@ "min":1, "pattern":"^[a-zA-Z0-9_ -]+$" }, + "SourceId":{ + "type":"string", + "max":255, + "min":1 + }, "SourceType":{ "type":"string", "enum":[ @@ -15391,7 +16803,7 @@ }, "ContactFlowId":{ "shape":"ContactFlowId", - "documentation":"

The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

" + "documentation":"

The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

" }, "Attributes":{ "shape":"Attributes", @@ -15583,7 +16995,7 @@ }, "ContactFlowId":{ "shape":"ContactFlowId", - "documentation":"

The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

" + "documentation":"

The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

" }, "InstanceId":{ "shape":"InstanceId", @@ -15646,7 +17058,7 @@ }, "ContactFlowId":{ "shape":"ContactFlowId", - "documentation":"

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

" + "documentation":"

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

" }, "Attributes":{ "shape":"Attributes", @@ -15696,6 +17108,71 @@ } } }, + "StartWebRTCContactRequest":{ + "type":"structure", + "required":[ + "ContactFlowId", + "InstanceId", + "ParticipantDetails" + ], + "members":{ + "Attributes":{ + "shape":"Attributes", + "documentation":"

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.

" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

", + "idempotencyToken":true + }, + "ContactFlowId":{ + "shape":"ContactFlowId", + "documentation":"

The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

" + }, + "AllowedCapabilities":{ + "shape":"AllowedCapabilities", + "documentation":"

Information about the video sharing capabilities of the participants (customer, agent).

" + }, + "ParticipantDetails":{"shape":"ParticipantDetails"}, + "RelatedContactId":{ + "shape":"ContactId", + "documentation":"

The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

" + }, + "References":{ + "shape":"ContactReferences", + "documentation":"

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

" + } + } + }, + "StartWebRTCContactResponse":{ + "type":"structure", + "members":{ + "ConnectionData":{ + "shape":"ConnectionData", + "documentation":"

Information required for the client application (mobile application or website) to connect to the call.

" + }, + "ContactId":{ + "shape":"ContactId", + "documentation":"

The identifier of the contact in this instance of Amazon Connect.

" + }, + "ParticipantId":{ + "shape":"ParticipantId", + "documentation":"

The identifier for a contact participant. The ParticipantId for a contact participant is the same throughout the contact lifecycle.

" + }, + "ParticipantToken":{ + "shape":"ParticipantToken", + "documentation":"

The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact participant.

" + } + } + }, "Statistic":{ "type":"string", "enum":[ @@ -15890,6 +17367,11 @@ } } }, + "Subtype":{ + "type":"string", + "max":100, + "min":1 + }, "SuccessfulRequest":{ "type":"structure", "members":{ @@ -18438,6 +19920,10 @@ "type":"integer", "min":1 }, + "VideoCapability":{ + "type":"string", + "enum":["SEND"] + }, "View":{ "type":"structure", "members":{ diff --git a/botocore/data/customer-profiles/2020-08-15/endpoint-rule-set-1.json b/botocore/data/customer-profiles/2020-08-15/endpoint-rule-set-1.json index 02edb0b68d..a20c929fbd 100644 --- a/botocore/data/customer-profiles/2020-08-15/endpoint-rule-set-1.json +++ b/botocore/data/customer-profiles/2020-08-15/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,11 +212,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -231,14 +227,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -252,7 +250,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -272,7 +269,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -283,14 +279,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -301,9 +299,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/botocore/data/customer-profiles/2020-08-15/service-2.json b/botocore/data/customer-profiles/2020-08-15/service-2.json index f32915054f..f555553333 100644 --- a/botocore/data/customer-profiles/2020-08-15/service-2.json +++ b/botocore/data/customer-profiles/2020-08-15/service-2.json @@ -269,6 +269,23 @@ ], "documentation":"

Deletes the specified workflow and all its corresponding resources. This is an async process.

" }, + "DetectProfileObjectType":{ + "name":"DetectProfileObjectType", + "http":{ + "method":"POST", + "requestUri":"/domains/{DomainName}/detect/object-types" + }, + "input":{"shape":"DetectProfileObjectTypeRequest"}, + "output":{"shape":"DetectProfileObjectTypeResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

The process of detecting profile object type mapping by using given objects.

" + }, "GetAutoMergingPreview":{ "name":"GetAutoMergingPreview", "http":{ @@ -2034,6 +2051,56 @@ }, "documentation":"

Summary information about the Kinesis data stream

" }, + "DetectProfileObjectTypeRequest":{ + "type":"structure", + "required":[ + "Objects", + "DomainName" + ], + "members":{ + "Objects":{ + "shape":"Objects", + "documentation":"

A string that is serialized from a JSON object.

" + }, + "DomainName":{ + "shape":"name", + "documentation":"

The unique name of the domain.

", + "location":"uri", + "locationName":"DomainName" + } + } + }, + "DetectProfileObjectTypeResponse":{ + "type":"structure", + "members":{ + "DetectedProfileObjectTypes":{ + "shape":"DetectedProfileObjectTypes", + "documentation":"

Detected ProfileObjectType mappings from given objects. A maximum of one mapping is supported.

" + } + } + }, + "DetectedProfileObjectType":{ + "type":"structure", + "members":{ + "SourceLastUpdatedTimestampFormat":{ + "shape":"string1To255", + "documentation":"

The format of sourceLastUpdatedTimestamp that was detected in fields.

" + }, + "Fields":{ + "shape":"FieldMap", + "documentation":"

A map of the name and the ObjectType field.

" + }, + "Keys":{ + "shape":"KeyMap", + "documentation":"

A list of unique keys that can be used to map data to a profile.

" + } + }, + "documentation":"

Contains ProfileObjectType mapping information from the model.

" + }, + "DetectedProfileObjectTypes":{ + "type":"list", + "member":{"shape":"DetectedProfileObjectType"} + }, "DomainList":{ "type":"list", "member":{"shape":"ListDomainItem"} @@ -4276,6 +4343,13 @@ "key":{"shape":"string1To255"}, "value":{"shape":"typeName"} }, + "Objects":{ + "type":"list", + "member":{"shape":"stringifiedJson"}, + "max":5, + "min":1, + "sensitive":true + }, "Operator":{ "type":"string", "enum":[ diff --git a/botocore/data/qbusiness/2023-11-27/endpoint-rule-set-1.json b/botocore/data/qbusiness/2023-11-27/endpoint-rule-set-1.json new file mode 100644 index 0000000000..b82f5c2551 --- /dev/null +++ b/botocore/data/qbusiness/2023-11-27/endpoint-rule-set-1.json @@ -0,0 +1,247 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://qbusiness-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://qbusiness.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://qbusiness-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://qbusiness.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/botocore/data/qbusiness/2023-11-27/paginators-1.json b/botocore/data/qbusiness/2023-11-27/paginators-1.json new file mode 100644 index 0000000000..d9de477c92 --- /dev/null +++ b/botocore/data/qbusiness/2023-11-27/paginators-1.json @@ -0,0 +1,76 @@ +{ + "pagination": { + "GetChatControlsConfiguration": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "topicConfigurations" + }, + "ListApplications": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "applications" + }, + "ListConversations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "conversations" + }, + "ListDataSourceSyncJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "history" + }, + "ListDataSources": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "dataSources" + }, + "ListDocuments": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "documentDetailList" + }, + "ListGroups": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" + }, + "ListIndices": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "indices" + }, + "ListMessages": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "messages" + }, + "ListPlugins": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "plugins" + }, + "ListRetrievers": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "retrievers" + }, + "ListWebExperiences": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "webExperiences" + } + } +} diff --git a/botocore/data/qbusiness/2023-11-27/service-2.json b/botocore/data/qbusiness/2023-11-27/service-2.json new file mode 100644 index 0000000000..87fb91b593 --- /dev/null +++ b/botocore/data/qbusiness/2023-11-27/service-2.json @@ -0,0 +1,5999 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2023-11-27", + "endpointPrefix":"qbusiness", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"QBusiness", + "serviceId":"QBusiness", + "signatureVersion":"v4", + "signingName":"qbusiness", + "uid":"qbusiness-2023-11-27" + }, + "operations":{ + "BatchDeleteDocument":{ + "name":"BatchDeleteDocument", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/indices/{indexId}/documents/delete", + "responseCode":200 + }, + "input":{"shape":"BatchDeleteDocumentRequest"}, + "output":{"shape":"BatchDeleteDocumentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

" + }, + "BatchPutDocument":{ + "name":"BatchPutDocument", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/indices/{indexId}/documents", + "responseCode":200 + }, + "input":{"shape":"BatchPutDocumentRequest"}, + "output":{"shape":"BatchPutDocumentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Adds one or more documents to an Amazon Q index.

You use this API to:

  • ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q index.

  • add custom attributes to documents in an Amazon Q index.

  • attach an access control list to the documents added to an Amazon Q index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

" + }, + "ChatSync":{ + "name":"ChatSync", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/conversations?sync", + "responseCode":200 + }, + "input":{"shape":"ChatSyncInput"}, + "output":{"shape":"ChatSyncOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"LicenseNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Starts or continues a non-streaming Amazon Q conversation.

" + }, + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/applications", + "responseCode":200 + }, + "input":{"shape":"CreateApplicationRequest"}, + "output":{"shape":"CreateApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates an Amazon Q application.

", + "idempotent":true + }, + "CreateDataSource":{ + "name":"CreateDataSource", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources", + "responseCode":200 + }, + "input":{"shape":"CreateDataSourceRequest"}, + "output":{"shape":"CreateDataSourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates a data source connector for an Amazon Q application.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

", + "idempotent":true + }, + "CreateIndex":{ + "name":"CreateIndex", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/indices", + "responseCode":200 + }, + "input":{"shape":"CreateIndexRequest"}, + "output":{"shape":"CreateIndexResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates an Amazon Q index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

" + }, + "CreatePlugin":{ + "name":"CreatePlugin", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/plugins", + "responseCode":200 + }, + "input":{"shape":"CreatePluginRequest"}, + "output":{"shape":"CreatePluginResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates an Amazon Q plugin.

", + "idempotent":true + }, + "CreateRetriever":{ + "name":"CreateRetriever", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/retrievers", + "responseCode":200 + }, + "input":{"shape":"CreateRetrieverRequest"}, + "output":{"shape":"CreateRetrieverResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Adds a retriever to your Amazon Q application.

" + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/users", + "responseCode":200 + }, + "input":{"shape":"CreateUserRequest"}, + "output":{"shape":"CreateUserResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

", + "idempotent":true + }, + "CreateWebExperience":{ + "name":"CreateWebExperience", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/experiences", + "responseCode":200 + }, + "input":{"shape":"CreateWebExperienceRequest"}, + "output":{"shape":"CreateWebExperienceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates an Amazon Q web experience.

" + }, + "DeleteApplication":{ + "name":"DeleteApplication", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}", + "responseCode":200 + }, + "input":{"shape":"DeleteApplicationRequest"}, + "output":{"shape":"DeleteApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes an Amazon Q application.

", + "idempotent":true + }, + "DeleteChatControlsConfiguration":{ + "name":"DeleteChatControlsConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}/chatcontrols", + "responseCode":200 + }, + "input":{"shape":"DeleteChatControlsConfigurationRequest"}, + "output":{"shape":"DeleteChatControlsConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes chat controls configured for an existing Amazon Q application.

", + "idempotent":true + }, + "DeleteConversation":{ + "name":"DeleteConversation", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}/conversations/{conversationId}", + "responseCode":200 + }, + "input":{"shape":"DeleteConversationRequest"}, + "output":{"shape":"DeleteConversationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"LicenseNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes an Amazon Q web experience conversation.

", + "idempotent":true + }, + "DeleteDataSource":{ + "name":"DeleteDataSource", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", + "responseCode":200 + }, + "input":{"shape":"DeleteDataSourceRequest"}, + "output":{"shape":"DeleteDataSourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes an Amazon Q data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.

", + "idempotent":true + }, + "DeleteGroup":{ + "name":"DeleteGroup", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}/indices/{indexId}/groups/{groupName}", + "responseCode":200 + }, + "input":{"shape":"DeleteGroupRequest"}, + "output":{"shape":"DeleteGroupResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group \"Summer Interns\", all interns who belonged to that group no longer see intern-only documents in their chat results.

If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group \"Engineering\" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the \"Engineering\" group when calling PutGroup.

", + "idempotent":true + }, + "DeleteIndex":{ + "name":"DeleteIndex", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}/indices/{indexId}", + "responseCode":200 + }, + "input":{"shape":"DeleteIndexRequest"}, + "output":{"shape":"DeleteIndexResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes an Amazon Q index.

", + "idempotent":true + }, + "DeletePlugin":{ + "name":"DeletePlugin", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}/plugins/{pluginId}", + "responseCode":200 + }, + "input":{"shape":"DeletePluginRequest"}, + "output":{"shape":"DeletePluginResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes an Amazon Q plugin.

", + "idempotent":true + }, + "DeleteRetriever":{ + "name":"DeleteRetriever", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}/retrievers/{retrieverId}", + "responseCode":200 + }, + "input":{"shape":"DeleteRetrieverRequest"}, + "output":{"shape":"DeleteRetrieverResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes the retriever used by an Amazon Q application.

", + "idempotent":true + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}/users/{userId}", + "responseCode":200 + }, + "input":{"shape":"DeleteUserRequest"}, + "output":{"shape":"DeleteUserResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes a user by email id.

", + "idempotent":true + }, + "DeleteWebExperience":{ + "name":"DeleteWebExperience", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}/experiences/{webExperienceId}", + "responseCode":200 + }, + "input":{"shape":"DeleteWebExperienceRequest"}, + "output":{"shape":"DeleteWebExperienceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes an Amazon Q web experience.

", + "idempotent":true + }, + "GetApplication":{ + "name":"GetApplication", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}", + "responseCode":200 + }, + "input":{"shape":"GetApplicationRequest"}, + "output":{"shape":"GetApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Gets information about an existing Amazon Q application.

" + }, + "GetChatControlsConfiguration":{ + "name":"GetChatControlsConfiguration", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/chatcontrols", + "responseCode":200 + }, + "input":{"shape":"GetChatControlsConfigurationRequest"}, + "output":{"shape":"GetChatControlsConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Gets information about an chat controls configured for an existing Amazon Q application.

" + }, + "GetDataSource":{ + "name":"GetDataSource", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", + "responseCode":200 + }, + "input":{"shape":"GetDataSourceRequest"}, + "output":{"shape":"GetDataSourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Gets information about an existing Amazon Q data source connector.

" + }, + "GetGroup":{ + "name":"GetGroup", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/indices/{indexId}/groups/{groupName}", + "responseCode":200 + }, + "input":{"shape":"GetGroupRequest"}, + "output":{"shape":"GetGroupResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Describes a group by group name.

" + }, + "GetIndex":{ + "name":"GetIndex", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/indices/{indexId}", + "responseCode":200 + }, + "input":{"shape":"GetIndexRequest"}, + "output":{"shape":"GetIndexResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Gets information about an existing Amazon Q index.

" + }, + "GetPlugin":{ + "name":"GetPlugin", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/plugins/{pluginId}", + "responseCode":200 + }, + "input":{"shape":"GetPluginRequest"}, + "output":{"shape":"GetPluginResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Gets information about an existing Amazon Q plugin.

" + }, + "GetRetriever":{ + "name":"GetRetriever", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/retrievers/{retrieverId}", + "responseCode":200 + }, + "input":{"shape":"GetRetrieverRequest"}, + "output":{"shape":"GetRetrieverResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Gets information about an existing retriever used by an Amazon Q application.

" + }, + "GetUser":{ + "name":"GetUser", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/users/{userId}", + "responseCode":200 + }, + "input":{"shape":"GetUserRequest"}, + "output":{"shape":"GetUserResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Describes the universally unique identifier (UUID) associated with a local user in a data source.

" + }, + "GetWebExperience":{ + "name":"GetWebExperience", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/experiences/{webExperienceId}", + "responseCode":200 + }, + "input":{"shape":"GetWebExperienceRequest"}, + "output":{"shape":"GetWebExperienceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Gets information about an existing Amazon Q web experience.

" + }, + "ListApplications":{ + "name":"ListApplications", + "http":{ + "method":"GET", + "requestUri":"/applications", + "responseCode":200 + }, + "input":{"shape":"ListApplicationsRequest"}, + "output":{"shape":"ListApplicationsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists Amazon Q applications.

" + }, + "ListConversations":{ + "name":"ListConversations", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/conversations", + "responseCode":200 + }, + "input":{"shape":"ListConversationsRequest"}, + "output":{"shape":"ListConversationsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"LicenseNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists one or more Amazon Q conversations.

" + }, + "ListDataSourceSyncJobs":{ + "name":"ListDataSourceSyncJobs", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs", + "responseCode":200 + }, + "input":{"shape":"ListDataSourceSyncJobsRequest"}, + "output":{"shape":"ListDataSourceSyncJobsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Get information about an Amazon Q data source connector synchronization.

" + }, + "ListDataSources":{ + "name":"ListDataSources", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources", + "responseCode":200 + }, + "input":{"shape":"ListDataSourcesRequest"}, + "output":{"shape":"ListDataSourcesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists the Amazon Q data source connectors that you have created.

" + }, + "ListDocuments":{ + "name":"ListDocuments", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/index/{indexId}/documents", + "responseCode":200 + }, + "input":{"shape":"ListDocumentsRequest"}, + "output":{"shape":"ListDocumentsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

A list of documents attached to an index.

" + }, + "ListGroups":{ + "name":"ListGroups", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/indices/{indexId}/groups", + "responseCode":200 + }, + "input":{"shape":"ListGroupsRequest"}, + "output":{"shape":"ListGroupsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Provides a list of groups that are mapped to users.

" + }, + "ListIndices":{ + "name":"ListIndices", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/indices", + "responseCode":200 + }, + "input":{"shape":"ListIndicesRequest"}, + "output":{"shape":"ListIndicesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists the Amazon Q indices you have created.

" + }, + "ListMessages":{ + "name":"ListMessages", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/conversations/{conversationId}", + "responseCode":200 + }, + "input":{"shape":"ListMessagesRequest"}, + "output":{"shape":"ListMessagesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"LicenseNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Gets a list of messages associated with an Amazon Q web experience.

" + }, + "ListPlugins":{ + "name":"ListPlugins", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/plugins", + "responseCode":200 + }, + "input":{"shape":"ListPluginsRequest"}, + "output":{"shape":"ListPluginsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists configured Amazon Q plugins.

" + }, + "ListRetrievers":{ + "name":"ListRetrievers", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/retrievers", + "responseCode":200 + }, + "input":{"shape":"ListRetrieversRequest"}, + "output":{"shape":"ListRetrieversResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists the retriever used by an Amazon Q application.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/v1/tags/{resourceARN}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Gets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.

" + }, + "ListWebExperiences":{ + "name":"ListWebExperiences", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/experiences", + "responseCode":200 + }, + "input":{"shape":"ListWebExperiencesRequest"}, + "output":{"shape":"ListWebExperiencesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists one or more Amazon Q Web Experiences.

" + }, + "PutFeedback":{ + "name":"PutFeedback", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/feedback", + "responseCode":200 + }, + "input":{"shape":"PutFeedbackRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Enables your end user to to provide feedback on their Amazon Q generated chat responses.

" + }, + "PutGroup":{ + "name":"PutGroup", + "http":{ + "method":"PUT", + "requestUri":"/applications/{applicationId}/indices/{indexId}/groups", + "responseCode":200 + }, + "input":{"shape":"PutGroupRequest"}, + "output":{"shape":"PutGroupResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Create, or updates, a mapping of users—who have access to a document—to groups.

You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q chat results.

", + "idempotent":true + }, + "StartDataSourceSyncJob":{ + "name":"StartDataSourceSyncJob", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/startsync", + "responseCode":200 + }, + "input":{"shape":"StartDataSourceSyncJobRequest"}, + "output":{"shape":"StartDataSourceSyncJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q returns a ConflictException.

" + }, + "StopDataSourceSyncJob":{ + "name":"StopDataSourceSyncJob", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/stopsync", + "responseCode":200 + }, + "input":{"shape":"StopDataSourceSyncJobRequest"}, + "output":{"shape":"StopDataSourceSyncJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Stops an Amazon Q data source connector synchronization job already in progress.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/v1/tags/{resourceARN}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Adds the specified tag to the specified Amazon Q application or data source resource. If the tag already exists, the existing value is replaced with the new value.

", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/v1/tags/{resourceARN}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Removes a tag from an Amazon Q application or a data source.

", + "idempotent":true + }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"PUT", + "requestUri":"/applications/{applicationId}", + "responseCode":200 + }, + "input":{"shape":"UpdateApplicationRequest"}, + "output":{"shape":"UpdateApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates an existing Amazon Q application.

", + "idempotent":true + }, + "UpdateChatControlsConfiguration":{ + "name":"UpdateChatControlsConfiguration", + "http":{ + "method":"PATCH", + "requestUri":"/applications/{applicationId}/chatcontrols", + "responseCode":200 + }, + "input":{"shape":"UpdateChatControlsConfigurationRequest"}, + "output":{"shape":"UpdateChatControlsConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Updates an set of chat controls configured for an existing Amazon Q application.

", + "idempotent":true + }, + "UpdateDataSource":{ + "name":"UpdateDataSource", + "http":{ + "method":"PUT", + "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", + "responseCode":200 + }, + "input":{"shape":"UpdateDataSourceRequest"}, + "output":{"shape":"UpdateDataSourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates an existing Amazon Q data source connector.

", + "idempotent":true + }, + "UpdateIndex":{ + "name":"UpdateIndex", + "http":{ + "method":"PUT", + "requestUri":"/applications/{applicationId}/indices/{indexId}", + "responseCode":200 + }, + "input":{"shape":"UpdateIndexRequest"}, + "output":{"shape":"UpdateIndexResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Updates an Amazon Q index.

", + "idempotent":true + }, + "UpdatePlugin":{ + "name":"UpdatePlugin", + "http":{ + "method":"PUT", + "requestUri":"/applications/{applicationId}/plugins/{pluginId}", + "responseCode":200 + }, + "input":{"shape":"UpdatePluginRequest"}, + "output":{"shape":"UpdatePluginResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Updates an Amazon Q plugin.

", + "idempotent":true + }, + "UpdateRetriever":{ + "name":"UpdateRetriever", + "http":{ + "method":"PUT", + "requestUri":"/applications/{applicationId}/retrievers/{retrieverId}", + "responseCode":200 + }, + "input":{"shape":"UpdateRetrieverRequest"}, + "output":{"shape":"UpdateRetrieverResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Updates the retriever used for your Amazon Q application.

", + "idempotent":true + }, + "UpdateUser":{ + "name":"UpdateUser", + "http":{ + "method":"PUT", + "requestUri":"/applications/{applicationId}/users/{userId}", + "responseCode":200 + }, + "input":{"shape":"UpdateUserRequest"}, + "output":{"shape":"UpdateUserResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Updates a information associated with a user id.

", + "idempotent":true + }, + "UpdateWebExperience":{ + "name":"UpdateWebExperience", + "http":{ + "method":"PUT", + "requestUri":"/applications/{applicationId}/experiences/{webExperienceId}", + "responseCode":200 + }, + "input":{"shape":"UpdateWebExperienceRequest"}, + "output":{"shape":"UpdateWebExperienceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates an Amazon Q web experience.

", + "idempotent":true + } + }, + "shapes":{ + "AccessConfiguration":{ + "type":"structure", + "required":["accessControls"], + "members":{ + "accessControls":{ + "shape":"AccessControls", + "documentation":"

A list of AccessControlList objects.

" + }, + "memberRelation":{ + "shape":"MemberRelation", + "documentation":"

Describes the member relation within the AccessControlList object.

" + } + }, + "documentation":"

Used to configure access permissions for a document.

" + }, + "AccessControl":{ + "type":"structure", + "required":["principals"], + "members":{ + "memberRelation":{ + "shape":"MemberRelation", + "documentation":"

Describes the member relation within a principal list.

" + }, + "principals":{ + "shape":"Principals", + "documentation":"

Contains a list of principals, where a principal can be either a USER or a GROUP. Each principal can be have the following type of document access: ALLOW or DENY.

" + } + }, + "documentation":"

A list of principals. Each principal can be either a USER or a GROUP and can be designated document access permissions of either ALLOW or DENY.

" + }, + "AccessControls":{ + "type":"list", + "member":{"shape":"AccessControl"} + }, + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ActionExecution":{ + "type":"structure", + "required":[ + "payload", + "payloadFieldNameSeparator", + "pluginId" + ], + "members":{ + "payload":{ + "shape":"ActionExecutionPayload", + "documentation":"

A mapping of field names to the field values in input that an end user provides to Amazon Q requests to perform their plugin action.

" + }, + "payloadFieldNameSeparator":{ + "shape":"ActionPayloadFieldNameSeparator", + "documentation":"

A string used to retain information about the hierarchical contexts within an action execution event payload.

" + }, + "pluginId":{ + "shape":"PluginId", + "documentation":"

The identifier of the plugin the action is attached to.

" + } + }, + "documentation":"

Performs an Amazon Q plugin action during a non-streaming chat conversation.

" + }, + "ActionExecutionPayload":{ + "type":"map", + "key":{"shape":"ActionPayloadFieldKey"}, + "value":{"shape":"ActionExecutionPayloadField"} + }, + "ActionExecutionPayloadField":{ + "type":"structure", + "required":["value"], + "members":{ + "value":{ + "shape":"ActionPayloadFieldValue", + "documentation":"

The content of a user input field in an plugin action execution payload.

" + } + }, + "documentation":"

A user input field in an plugin action execution payload.

" + }, + "ActionPayloadFieldKey":{ + "type":"string", + "min":1 + }, + "ActionPayloadFieldNameSeparator":{ + "type":"string", + "max":1, + "min":1 + }, + "ActionPayloadFieldType":{ + "type":"string", + "enum":[ + "STRING", + "NUMBER", + "ARRAY", + "BOOLEAN" + ] + }, + "ActionPayloadFieldValue":{ + "type":"structure", + "members":{ + }, + "document":true + }, + "ActionReview":{ + "type":"structure", + "members":{ + "payload":{ + "shape":"ActionReviewPayload", + "documentation":"

Field values that an end user needs to provide to Amazon Q for Amazon Q to perform the requested plugin action.

" + }, + "payloadFieldNameSeparator":{ + "shape":"ActionPayloadFieldNameSeparator", + "documentation":"

A string used to retain information about the hierarchical contexts within an action review payload.

" + }, + "pluginId":{ + "shape":"PluginId", + "documentation":"

The identifier of the plugin associated with the action review.

" + }, + "pluginType":{ + "shape":"PluginType", + "documentation":"

The type of plugin.

" + } + }, + "documentation":"

An output event that Amazon Q returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q.

" + }, + "ActionReviewPayload":{ + "type":"map", + "key":{"shape":"ActionPayloadFieldKey"}, + "value":{"shape":"ActionReviewPayloadField"} + }, + "ActionReviewPayloadField":{ + "type":"structure", + "members":{ + "allowedValues":{ + "shape":"ActionReviewPayloadFieldAllowedValues", + "documentation":"

Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.

" + }, + "displayName":{ + "shape":"String", + "documentation":"

The name of the field.

" + }, + "displayOrder":{ + "shape":"Integer", + "documentation":"

The display order of fields in a payload.

" + }, + "required":{ + "shape":"Boolean", + "documentation":"

Information about whether the field is required.

" + }, + "type":{ + "shape":"ActionPayloadFieldType", + "documentation":"

The type of field.

" + }, + "value":{ + "shape":"ActionPayloadFieldValue", + "documentation":"

The field value.

" + } + }, + "documentation":"

A user input field in an plugin action review payload.

" + }, + "ActionReviewPayloadFieldAllowedValue":{ + "type":"structure", + "members":{ + "displayValue":{ + "shape":"ActionPayloadFieldValue", + "documentation":"

The name of the field.

" + }, + "value":{ + "shape":"ActionPayloadFieldValue", + "documentation":"

The field value.

" + } + }, + "documentation":"

Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.

" + }, + "ActionReviewPayloadFieldAllowedValues":{ + "type":"list", + "member":{"shape":"ActionReviewPayloadFieldAllowedValue"} + }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1 + }, + "Application":{ + "type":"structure", + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier for the Amazon Q application.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the Amazon Q application was created.

" + }, + "displayName":{ + "shape":"ApplicationName", + "documentation":"

The name of the Amazon Q application.

" + }, + "status":{ + "shape":"ApplicationStatus", + "documentation":"

The status of the Amazon Q application. The application is ready to use when the status is ACTIVE.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" + } + }, + "documentation":"

Summary information for an Amazon Q application.

" + }, + "ApplicationArn":{ + "type":"string", + "max":1284, + "min":0, + "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + }, + "ApplicationId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + }, + "ApplicationName":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + }, + "ApplicationStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ] + }, + "Applications":{ + "type":"list", + "member":{"shape":"Application"} + }, + "AppliedAttachmentsConfiguration":{ + "type":"structure", + "members":{ + "attachmentsControlMode":{ + "shape":"AttachmentsControlMode", + "documentation":"

Information about whether file upload during chat functionality is activated for your application.

" + } + }, + "documentation":"

Configuration information about the file upload during chat feature for your application.

" + }, + "AttachmentInput":{ + "type":"structure", + "required":[ + "data", + "name" + ], + "members":{ + "data":{ + "shape":"Blob", + "documentation":"

The data contained within the uploaded file.

" + }, + "name":{ + "shape":"AttachmentName", + "documentation":"

The name of the file.

" + } + }, + "documentation":"

A file directly uploaded into a web experience chat.

" + }, + "AttachmentName":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"^\\P{C}*$" + }, + "AttachmentOutput":{ + "type":"structure", + "members":{ + "error":{ + "shape":"ErrorDetail", + "documentation":"

An error associated with a file uploaded during chat.

" + }, + "name":{ + "shape":"AttachmentName", + "documentation":"

The name of a file uploaded during chat.

" + }, + "status":{ + "shape":"AttachmentStatus", + "documentation":"

The status of a file uploaded during chat.

" + } + }, + "documentation":"

The details of a file uploaded during chat.

" + }, + "AttachmentStatus":{ + "type":"string", + "enum":[ + "FAILED", + "SUCCEEDED" + ] + }, + "AttachmentsConfiguration":{ + "type":"structure", + "required":["attachmentsControlMode"], + "members":{ + "attachmentsControlMode":{ + "shape":"AttachmentsControlMode", + "documentation":"

Status information about whether file upload functionality is activated or deactivated for your end user.

" + } + }, + "documentation":"

Configuration information for the file upload during chat feature.

" + }, + "AttachmentsControlMode":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "AttachmentsInput":{ + "type":"list", + "member":{"shape":"AttachmentInput"}, + "min":1 + }, + "AttachmentsOutput":{ + "type":"list", + "member":{"shape":"AttachmentOutput"} + }, + "AttributeFilter":{ + "type":"structure", + "members":{ + "andAllFilters":{ + "shape":"AttributeFilters", + "documentation":"

Performs a logical AND operation on all supplied filters.

" + }, + "containsAll":{ + "shape":"DocumentAttribute", + "documentation":"

Returns true when a document contains all the specified document attributes or metadata fields.

" + }, + "containsAny":{ + "shape":"DocumentAttribute", + "documentation":"

Returns true when a document contains any of the specified document attributes or metadata fields.

" + }, + "equalsTo":{ + "shape":"DocumentAttribute", + "documentation":"

Performs an equals operation on two document attributes or metadata fields.

" + }, + "greaterThan":{ + "shape":"DocumentAttribute", + "documentation":"

Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

" + }, + "greaterThanOrEquals":{ + "shape":"DocumentAttribute", + "documentation":"

Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

" + }, + "lessThan":{ + "shape":"DocumentAttribute", + "documentation":"

Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

" + }, + "lessThanOrEquals":{ + "shape":"DocumentAttribute", + "documentation":"

Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

" + }, + "notFilter":{ + "shape":"AttributeFilter", + "documentation":"

Performs a logical NOT operation on all supplied filters.

" + }, + "orAllFilters":{ + "shape":"AttributeFilters", + "documentation":"

Performs a logical OR operation on all supplied filters.

" + } + }, + "documentation":"

Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.

" + }, + "AttributeFilters":{ + "type":"list", + "member":{"shape":"AttributeFilter"} + }, + "AttributeType":{ + "type":"string", + "enum":[ + "STRING", + "STRING_LIST", + "NUMBER", + "DATE" + ] + }, + "AttributeValueOperator":{ + "type":"string", + "enum":["DELETE"] + }, + "BasicAuthConfiguration":{ + "type":"structure", + "required":[ + "roleArn", + "secretArn" + ], + "members":{ + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.

" + }, + "secretArn":{ + "shape":"SecretArn", + "documentation":"

The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

" + } + }, + "documentation":"

Information about the basic authentication credentials used to configure a plugin.

" + }, + "BatchDeleteDocumentRequest":{ + "type":"structure", + "required":[ + "applicationId", + "documents", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceSyncId":{ + "shape":"ExecutionId", + "documentation":"

The identifier of the data source sync during which the documents were deleted.

" + }, + "documents":{ + "shape":"DeleteDocuments", + "documentation":"

Documents deleted from the Amazon Q index.

" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the Amazon Q index that contains the documents to delete.

", + "location":"uri", + "locationName":"indexId" + } + } + }, + "BatchDeleteDocumentResponse":{ + "type":"structure", + "members":{ + "failedDocuments":{ + "shape":"FailedDocuments", + "documentation":"

A list of documents that couldn't be removed from the Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

" + } + } + }, + "BatchPutDocumentRequest":{ + "type":"structure", + "required":[ + "applicationId", + "documents", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceSyncId":{ + "shape":"ExecutionId", + "documentation":"

The identifier of the data source sync during which the documents were added.

" + }, + "documents":{ + "shape":"Documents", + "documentation":"

One or more documents to add to the index.

" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the Amazon Q index to add the documents to.

", + "location":"uri", + "locationName":"indexId" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

" + } + } + }, + "BatchPutDocumentResponse":{ + "type":"structure", + "members":{ + "failedDocuments":{ + "shape":"FailedDocuments", + "documentation":"

A list of documents that were not added to the Amazon Q index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.

" + } + } + }, + "Blob":{"type":"blob"}, + "BlockedPhrase":{ + "type":"string", + "max":36, + "min":0, + "pattern":"^\\P{C}*$" + }, + "BlockedPhrases":{ + "type":"list", + "member":{"shape":"BlockedPhrase"}, + "max":5, + "min":0 + }, + "BlockedPhrasesConfiguration":{ + "type":"structure", + "members":{ + "blockedPhrases":{ + "shape":"BlockedPhrases", + "documentation":"

A list of phrases blocked from a Amazon Q web experience chat.

" + }, + "systemMessageOverride":{ + "shape":"SystemMessageOverride", + "documentation":"

The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

" + } + }, + "documentation":"

Provides information about the phrases blocked from chat by your chat control configuration.

" + }, + "BlockedPhrasesConfigurationUpdate":{ + "type":"structure", + "members":{ + "blockedPhrasesToCreateOrUpdate":{ + "shape":"BlockedPhrases", + "documentation":"

Creates or updates a blocked phrases configuration in your Amazon Q application.

" + }, + "blockedPhrasesToDelete":{ + "shape":"BlockedPhrases", + "documentation":"

Deletes a blocked phrases configuration in your Amazon Q application.

" + }, + "systemMessageOverride":{ + "shape":"SystemMessageOverride", + "documentation":"

The configured custom message displayed to your end user when they use blocked phrase during chat.

" + } + }, + "documentation":"

Updates a blocked phrases configuration in your Amazon Q application.

" + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ChatSyncInput":{ + "type":"structure", + "required":[ + "applicationId", + "userId" + ], + "members":{ + "actionExecution":{ + "shape":"ActionExecution", + "documentation":"

A request from an end user to perform an Amazon Q plugin action.

" + }, + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application linked to the Amazon Q conversation.

", + "location":"uri", + "locationName":"applicationId" + }, + "attachments":{ + "shape":"AttachmentsInput", + "documentation":"

A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

" + }, + "attributeFilter":{ + "shape":"AttributeFilter", + "documentation":"

Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.

" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A token that you provide to identify a chat request.

", + "idempotencyToken":true + }, + "conversationId":{ + "shape":"ConversationId", + "documentation":"

The identifier of the Amazon Q conversation.

" + }, + "parentMessageId":{ + "shape":"MessageId", + "documentation":"

The identifier of the previous end user text input message in a conversation.

" + }, + "userGroups":{ + "shape":"UserGroups", + "documentation":"

The groups that a user associated with the chat input belongs to.

", + "location":"querystring", + "locationName":"userGroups" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The identifier of the user attached to the chat input.

", + "location":"querystring", + "locationName":"userId" + }, + "userMessage":{ + "shape":"UserMessage", + "documentation":"

A end user message in a conversation.

" + } + } + }, + "ChatSyncOutput":{ + "type":"structure", + "members":{ + "actionReview":{ + "shape":"ActionReview", + "documentation":"

A request from Amazon Q to the end user for information Amazon Q needs to successfully complete a requested plugin action.

" + }, + "conversationId":{ + "shape":"ConversationId", + "documentation":"

The identifier of the Amazon Q conversation.

" + }, + "failedAttachments":{ + "shape":"AttachmentsOutput", + "documentation":"

A list of files which failed to upload during chat.

" + }, + "sourceAttributions":{ + "shape":"SourceAttributions", + "documentation":"

The source documents used to generate the conversation response.

" + }, + "systemMessage":{ + "shape":"String", + "documentation":"

An AI-generated message in a conversation.

" + }, + "systemMessageId":{ + "shape":"MessageId", + "documentation":"

The identifier of an Amazon Q AI generated message within the conversation.

" + }, + "userMessageId":{ + "shape":"MessageId", + "documentation":"

The identifier of an Amazon Q end user text input message within the conversation.

" + } + } + }, + "ClientToken":{ + "type":"string", + "max":100, + "min":1 + }, + "ConflictException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The message describing a ConflictException.

" + }, + "resourceId":{ + "shape":"String", + "documentation":"

The identifier of the resource affected.

" + }, + "resourceType":{ + "shape":"String", + "documentation":"

The type of the resource affected.

" + } + }, + "documentation":"

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ContentBlockerRule":{ + "type":"structure", + "members":{ + "systemMessageOverride":{ + "shape":"SystemMessageOverride", + "documentation":"

The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

" + } + }, + "documentation":"

A rule for configuring how Amazon Q responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.

" + }, + "ContentRetrievalRule":{ + "type":"structure", + "members":{ + "eligibleDataSources":{ + "shape":"EligibleDataSources", + "documentation":"

Specifies data sources in a Amazon Q application to use for content generation.

" + } + }, + "documentation":"

Rules for retrieving content from data sources connected to a Amazon Q application for a specific topic control configuration.

" + }, + "ContentType":{ + "type":"string", + "enum":[ + "PDF", + "HTML", + "MS_WORD", + "PLAIN_TEXT", + "PPT", + "RTF", + "XML", + "XSLT", + "MS_EXCEL", + "CSV", + "JSON", + "MD" + ] + }, + "Conversation":{ + "type":"structure", + "members":{ + "conversationId":{ + "shape":"ConversationId", + "documentation":"

The identifier of the Amazon Q conversation.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the conversation.

" + }, + "title":{ + "shape":"ConversationTitle", + "documentation":"

The title of the conversation.

" + } + }, + "documentation":"

A conversation in an Amazon Q application.

" + }, + "ConversationId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + }, + "ConversationTitle":{"type":"string"}, + "Conversations":{ + "type":"list", + "member":{"shape":"Conversation"} + }, + "CreateApplicationRequest":{ + "type":"structure", + "required":[ + "displayName", + "roleArn" + ], + "members":{ + "attachmentsConfiguration":{ + "shape":"AttachmentsConfiguration", + "documentation":"

An option to allow end users to upload files directly during chat.

" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A token that you provide to identify the request to create your Amazon Q application.

", + "idempotencyToken":true + }, + "description":{ + "shape":"Description", + "documentation":"

A description for the Amazon Q application.

" + }, + "displayName":{ + "shape":"ApplicationName", + "documentation":"

A name for the Amazon Q application.

" + }, + "encryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

The identifier of the KMS key that is used to encrypt your data. Amazon Q doesn't support asymmetric keys.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

A list of key-value pairs that identify or categorize your Amazon Q application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" + } + } + }, + "CreateApplicationResponse":{ + "type":"structure", + "members":{ + "applicationArn":{ + "shape":"ApplicationArn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q application.

" + }, + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application.

" + } + } + }, + "CreateDataSourceRequest":{ + "type":"structure", + "required":[ + "applicationId", + "configuration", + "displayName", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application the data source will be attached to.

", + "location":"uri", + "locationName":"applicationId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

", + "idempotencyToken":true + }, + "configuration":{ + "shape":"DataSourceConfiguration", + "documentation":"

Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description for the data source connector.

" + }, + "displayName":{ + "shape":"DataSourceName", + "documentation":"

A name for the data source connector.

" + }, + "documentEnrichmentConfiguration":{"shape":"DocumentEnrichmentConfiguration"}, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index that you want to use with the data source connector.

", + "location":"uri", + "locationName":"indexId" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

" + }, + "syncSchedule":{ + "shape":"SyncSchedule", + "documentation":"

Sets the frequency for Amazon Q to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q won't periodically update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" + }, + "vpcConfiguration":{ + "shape":"DataSourceVpcConfiguration", + "documentation":"

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q connectors.

" + } + } + }, + "CreateDataSourceResponse":{ + "type":"structure", + "members":{ + "dataSourceArn":{ + "shape":"DataSourceArn", + "documentation":"

The Amazon Resource Name (ARN) of a data source in an Amazon Q application.

" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source connector.

" + } + } + }, + "CreateIndexRequest":{ + "type":"structure", + "required":[ + "applicationId", + "displayName" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application using the index.

", + "location":"uri", + "locationName":"applicationId" + }, + "capacityConfiguration":{ + "shape":"IndexCapacityConfiguration", + "documentation":"

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

", + "idempotencyToken":true + }, + "description":{ + "shape":"Description", + "documentation":"

A description for the Amazon Q index.

" + }, + "displayName":{ + "shape":"IndexName", + "documentation":"

A name for the Amazon Q index.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" + } + } + }, + "CreateIndexResponse":{ + "type":"structure", + "members":{ + "indexArn":{ + "shape":"IndexArn", + "documentation":"

The Amazon Resource Name (ARN) of an Amazon Q index.

" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier for the Amazon Q index.

" + } + } + }, + "CreatePluginRequest":{ + "type":"structure", + "required":[ + "applicationId", + "authConfiguration", + "displayName", + "serverUrl", + "type" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application that will contain the plugin.

", + "location":"uri", + "locationName":"applicationId" + }, + "authConfiguration":{"shape":"PluginAuthConfiguration"}, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A token that you provide to identify the request to create your Amazon Q plugin.

", + "idempotencyToken":true + }, + "displayName":{ + "shape":"PluginName", + "documentation":"

A the name for your plugin.

" + }, + "serverUrl":{ + "shape":"Url", + "documentation":"

The source URL used for plugin configuration.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" + }, + "type":{ + "shape":"PluginType", + "documentation":"

The type of plugin you want to create.

" + } + } + }, + "CreatePluginResponse":{ + "type":"structure", + "members":{ + "pluginArn":{ + "shape":"PluginArn", + "documentation":"

The Amazon Resource Name (ARN) of a plugin.

" + }, + "pluginId":{ + "shape":"PluginId", + "documentation":"

The identifier of the plugin created.

" + } + } + }, + "CreateRetrieverRequest":{ + "type":"structure", + "required":[ + "applicationId", + "configuration", + "displayName", + "type" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of your Amazon Q application.

", + "location":"uri", + "locationName":"applicationId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A token that you provide to identify the request to create your Amazon Q application retriever.

", + "idempotencyToken":true + }, + "configuration":{"shape":"RetrieverConfiguration"}, + "displayName":{ + "shape":"RetrieverName", + "documentation":"

The name of your retriever.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" + }, + "type":{ + "shape":"RetrieverType", + "documentation":"

The type of retriever you are using.

" + } + } + }, + "CreateRetrieverResponse":{ + "type":"structure", + "members":{ + "retrieverArn":{ + "shape":"RetrieverArn", + "documentation":"

The Amazon Resource Name (ARN) of an IAM role associated with a retriever.

" + }, + "retrieverId":{ + "shape":"RetrieverId", + "documentation":"

The identifier of the retriever you are using.

" + } + } + }, + "CreateUserRequest":{ + "type":"structure", + "required":[ + "applicationId", + "userId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application for which the user mapping will be created.

", + "location":"uri", + "locationName":"applicationId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A token that you provide to identify the request to create your Amazon Q user mapping.

", + "idempotencyToken":true + }, + "userAliases":{ + "shape":"CreateUserRequestUserAliasesList", + "documentation":"

The list of user aliases in the mapping.

" + }, + "userId":{ + "shape":"String", + "documentation":"

The user emails attached to a user mapping.

" + } + } + }, + "CreateUserRequestUserAliasesList":{ + "type":"list", + "member":{"shape":"UserAlias"}, + "max":100, + "min":0 + }, + "CreateUserResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateWebExperienceRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q web experience.

", + "location":"uri", + "locationName":"applicationId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A token you provide to identify a request to create an Amazon Q web experience.

", + "idempotencyToken":true + }, + "samplePromptsControlMode":{ + "shape":"WebExperienceSamplePromptsControlMode", + "documentation":"

Determines whether sample prompts are enabled in the web experience for an end user.

" + }, + "subtitle":{ + "shape":"WebExperienceSubtitle", + "documentation":"

A subtitle to personalize your Amazon Q web experience.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

A list of key-value pairs that identify or categorize your Amazon Q web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" + }, + "title":{ + "shape":"WebExperienceTitle", + "documentation":"

The title for your Amazon Q web experience.

" + }, + "welcomeMessage":{ + "shape":"WebExperienceWelcomeMessage", + "documentation":"

The customized welcome message for end users of an Amazon Q web experience.

" + } + } + }, + "CreateWebExperienceResponse":{ + "type":"structure", + "members":{ + "webExperienceArn":{ + "shape":"WebExperienceArn", + "documentation":"

The Amazon Resource Name (ARN) of an Amazon Q web experience.

" + }, + "webExperienceId":{ + "shape":"WebExperienceId", + "documentation":"

The identifier of the Amazon Q web experience.

" + } + } + }, + "DataSource":{ + "type":"structure", + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the Amazon Q data source was created.

" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the Amazon Q data source.

" + }, + "displayName":{ + "shape":"DataSourceName", + "documentation":"

The name of the Amazon Q data source.

" + }, + "status":{ + "shape":"DataSourceStatus", + "documentation":"

The status of the Amazon Q data source.

" + }, + "type":{ + "shape":"String", + "documentation":"

The type of the Amazon Q data source.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the Amazon Q data source was last updated.

" + } + }, + "documentation":"

A data source in an Amazon Q application.

" + }, + "DataSourceArn":{ + "type":"string", + "max":1284, + "min":0, + "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + }, + "DataSourceConfiguration":{ + "type":"structure", + "members":{ + }, + "documentation":"

Provides the configuration information for an Amazon Q data source.

", + "document":true + }, + "DataSourceId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + }, + "DataSourceIds":{ + "type":"list", + "member":{"shape":"DataSourceId"}, + "max":1, + "min":1 + }, + "DataSourceName":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + }, + "DataSourceStatus":{ + "type":"string", + "enum":[ + "PENDING_CREATION", + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ] + }, + "DataSourceSyncJob":{ + "type":"structure", + "members":{ + "dataSourceErrorCode":{ + "shape":"String", + "documentation":"

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the synchronization job completed.

" + }, + "error":{ + "shape":"ErrorDetail", + "documentation":"

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

" + }, + "executionId":{ + "shape":"ExecutionId", + "documentation":"

The identifier of a data source synchronization job.

" + }, + "metrics":{ + "shape":"DataSourceSyncJobMetrics", + "documentation":"

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The Unix time stamp when the data source synchronization job started.

" + }, + "status":{ + "shape":"DataSourceSyncJobStatus", + "documentation":"

The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

" + } + }, + "documentation":"

Provides information about an Amazon Q data source connector synchronization job.

" + }, + "DataSourceSyncJobMetrics":{ + "type":"structure", + "members":{ + "documentsAdded":{ + "shape":"MetricValue", + "documentation":"

The current count of documents added from the data source during the data source sync.

" + }, + "documentsDeleted":{ + "shape":"MetricValue", + "documentation":"

The current count of documents deleted from the data source during the data source sync.

" + }, + "documentsFailed":{ + "shape":"MetricValue", + "documentation":"

The current count of documents that failed to sync from the data source during the data source sync.

" + }, + "documentsModified":{ + "shape":"MetricValue", + "documentation":"

The current count of documents modified in the data source during the data source sync.

" + }, + "documentsScanned":{ + "shape":"MetricValue", + "documentation":"

The current count of documents crawled by the ongoing sync job in the data source.

" + } + }, + "documentation":"

Maps a batch delete document request to a specific Amazon Q data source connector sync job.

" + }, + "DataSourceSyncJobStatus":{ + "type":"string", + "enum":[ + "FAILED", + "SUCCEEDED", + "SYNCING", + "INCOMPLETE", + "STOPPING", + "ABORTED", + "SYNCING_INDEXING" + ] + }, + "DataSourceSyncJobs":{ + "type":"list", + "member":{"shape":"DataSourceSyncJob"} + }, + "DataSourceUserId":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^\\P{C}*$" + }, + "DataSourceVpcConfiguration":{ + "type":"structure", + "required":[ + "securityGroupIds", + "subnetIds" + ], + "members":{ + "securityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q to connect to the data source.

" + }, + "subnetIds":{ + "shape":"SubnetIds", + "documentation":"

A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

" + } + }, + "documentation":"

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

" + }, + "DataSources":{ + "type":"list", + "member":{"shape":"DataSource"} + }, + "DeleteApplicationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application.

", + "location":"uri", + "locationName":"applicationId" + } + } + }, + "DeleteApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteChatControlsConfigurationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application the chat controls have been configured for.

", + "location":"uri", + "locationName":"applicationId" + } + } + }, + "DeleteChatControlsConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteConversationRequest":{ + "type":"structure", + "required":[ + "applicationId", + "conversationId", + "userId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application associated with the conversation.

", + "location":"uri", + "locationName":"applicationId" + }, + "conversationId":{ + "shape":"ConversationId", + "documentation":"

The identifier of the Amazon Q web experience conversation being deleted.

", + "location":"uri", + "locationName":"conversationId" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The identifier of the user who is deleting the conversation.

", + "location":"querystring", + "locationName":"userId" + } + } + }, + "DeleteConversationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDataSourceRequest":{ + "type":"structure", + "required":[ + "applicationId", + "dataSourceId", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application used with the data source connector.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source connector that you want to delete.

", + "location":"uri", + "locationName":"dataSourceId" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index used with the data source connector.

", + "location":"uri", + "locationName":"indexId" + } + } + }, + "DeleteDataSourceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDocument":{ + "type":"structure", + "required":["documentId"], + "members":{ + "documentId":{ + "shape":"DocumentId", + "documentation":"

The identifier of the deleted document.

" + } + }, + "documentation":"

A document deleted from an Amazon Q data source connector.

" + }, + "DeleteDocuments":{ + "type":"list", + "member":{"shape":"DeleteDocument"} + }, + "DeleteGroupRequest":{ + "type":"structure", + "required":[ + "applicationId", + "groupName", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application in which the group mapping belongs.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source linked to the group

A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups \"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete \"Research\" and \"Engineering\" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only \"Sales and Marketing\" should access documents in the Salesforce data source.

", + "location":"querystring", + "locationName":"dataSourceId" + }, + "groupName":{ + "shape":"GroupName", + "documentation":"

The name of the group you want to delete.

", + "location":"uri", + "locationName":"groupName" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index you want to delete the group from.

", + "location":"uri", + "locationName":"indexId" + } + } + }, + "DeleteGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteIndexRequest":{ + "type":"structure", + "required":[ + "applicationId", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application the Amazon Q index is linked to.

", + "location":"uri", + "locationName":"applicationId" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the Amazon Q index.

", + "location":"uri", + "locationName":"indexId" + } + } + }, + "DeleteIndexResponse":{ + "type":"structure", + "members":{ + } + }, + "DeletePluginRequest":{ + "type":"structure", + "required":[ + "applicationId", + "pluginId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier the application attached to the Amazon Q plugin.

", + "location":"uri", + "locationName":"applicationId" + }, + "pluginId":{ + "shape":"PluginId", + "documentation":"

The identifier of the plugin being deleted.

", + "location":"uri", + "locationName":"pluginId" + } + } + }, + "DeletePluginResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRetrieverRequest":{ + "type":"structure", + "required":[ + "applicationId", + "retrieverId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application using the retriever.

", + "location":"uri", + "locationName":"applicationId" + }, + "retrieverId":{ + "shape":"RetrieverId", + "documentation":"

The identifier of the retriever being deleted.

", + "location":"uri", + "locationName":"retrieverId" + } + } + }, + "DeleteRetrieverResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":[ + "applicationId", + "userId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application from which the user is being deleted.

", + "location":"uri", + "locationName":"applicationId" + }, + "userId":{ + "shape":"String", + "documentation":"

The user email being deleted.

", + "location":"uri", + "locationName":"userId" + } + } + }, + "DeleteUserResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteWebExperienceRequest":{ + "type":"structure", + "required":[ + "applicationId", + "webExperienceId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application linked to the Amazon Q web experience.

", + "location":"uri", + "locationName":"applicationId" + }, + "webExperienceId":{ + "shape":"WebExperienceId", + "documentation":"

The identifier of the Amazon Q web experience being deleted.

", + "location":"uri", + "locationName":"webExperienceId" + } + } + }, + "DeleteWebExperienceResponse":{ + "type":"structure", + "members":{ + } + }, + "Description":{ + "type":"string", + "max":1000, + "min":0, + "pattern":"^\\P{C}*$" + }, + "Document":{ + "type":"structure", + "required":["id"], + "members":{ + "accessConfiguration":{ + "shape":"AccessConfiguration", + "documentation":"

Configuration information for access permission to a document.

" + }, + "attributes":{ + "shape":"DocumentAttributes", + "documentation":"

Custom attributes to apply to the document for refining Amazon Q web experience responses.

" + }, + "content":{ + "shape":"DocumentContent", + "documentation":"

The contents of the document.

" + }, + "contentType":{ + "shape":"ContentType", + "documentation":"

The file type of the document in the Blob field.

If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.

" + }, + "documentEnrichmentConfiguration":{ + "shape":"DocumentEnrichmentConfiguration", + "documentation":"

The configuration information for altering document metadata and content during the document ingestion process.

" + }, + "id":{ + "shape":"DocumentId", + "documentation":"

The identifier of the document.

" + }, + "title":{ + "shape":"Title", + "documentation":"

The title of the document.

" + } + }, + "documentation":"

A document in an Amazon Q application.

" + }, + "DocumentAttribute":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"DocumentAttributeKey", + "documentation":"

The identifier for the attribute.

" + }, + "value":{ + "shape":"DocumentAttributeValue", + "documentation":"

The value of the attribute.

" + } + }, + "documentation":"

A document attribute or metadata field.

" + }, + "DocumentAttributeCondition":{ + "type":"structure", + "required":[ + "key", + "operator" + ], + "members":{ + "key":{ + "shape":"DocumentAttributeKey", + "documentation":"

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q currently doesn't support _document_body as an attribute key used for the condition.

" + }, + "operator":{ + "shape":"DocumentEnrichmentConditionOperator", + "documentation":"

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

" + }, + "value":{"shape":"DocumentAttributeValue"} + }, + "documentation":"

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Q can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q then will map your newly created metadata field to your index field.

" + }, + "DocumentAttributeConfiguration":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the document attribute.

" + }, + "search":{ + "shape":"Status", + "documentation":"

Information about whether the document attribute can be used by an end user to search for information on their web experience.

" + }, + "type":{ + "shape":"AttributeType", + "documentation":"

The type of document attribute.

" + } + }, + "documentation":"

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes.

" + }, + "DocumentAttributeConfigurations":{ + "type":"list", + "member":{"shape":"DocumentAttributeConfiguration"}, + "max":500, + "min":1 + }, + "DocumentAttributeKey":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[a-zA-Z0-9_][a-zA-Z0-9_-]*$" + }, + "DocumentAttributeStringListValue":{ + "type":"list", + "member":{"shape":"String"} + }, + "DocumentAttributeTarget":{ + "type":"structure", + "required":["key"], + "members":{ + "attributeValueOperator":{ + "shape":"AttributeValueOperator", + "documentation":"

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

" + }, + "key":{ + "shape":"DocumentAttributeKey", + "documentation":"

The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

" + }, + "value":{"shape":"DocumentAttributeValue"} + }, + "documentation":"

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Q can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeCondition .

" + }, + "DocumentAttributeValue":{ + "type":"structure", + "members":{ + "dateValue":{ + "shape":"Timestamp", + "documentation":"

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

" + }, + "longValue":{ + "shape":"Long", + "documentation":"

A long integer value.

" + }, + "stringListValue":{ + "shape":"DocumentAttributeStringListValue", + "documentation":"

A list of strings.

" + }, + "stringValue":{ + "shape":"DocumentAttributeValueStringValueString", + "documentation":"

A string.

" + } + }, + "documentation":"

The value of a document attribute. You can only provide one value for a document attribute.

", + "union":true + }, + "DocumentAttributeValueStringValueString":{ + "type":"string", + "max":2048, + "min":0 + }, + "DocumentAttributes":{ + "type":"list", + "member":{"shape":"DocumentAttribute"}, + "max":500, + "min":1 + }, + "DocumentContent":{ + "type":"structure", + "members":{ + "blob":{ + "shape":"Blob", + "documentation":"

The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q APIs. If you are calling the Amazon Q endpoint directly using REST, you must base64 encode the contents before sending.

" + }, + "s3":{ + "shape":"S3", + "documentation":"

The path to the document in an Amazon S3 bucket.

" + } + }, + "documentation":"

The contents of a document.

", + "union":true + }, + "DocumentContentOperator":{ + "type":"string", + "enum":["DELETE"] + }, + "DocumentDetailList":{ + "type":"list", + "member":{"shape":"DocumentDetails"} + }, + "DocumentDetails":{ + "type":"structure", + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The timestamp for when the document was created.

" + }, + "documentId":{ + "shape":"DocumentId", + "documentation":"

The identifier of the document.

" + }, + "error":{ + "shape":"ErrorDetail", + "documentation":"

An error message associated with the document.

" + }, + "status":{ + "shape":"DocumentStatus", + "documentation":"

The current status of the document.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The timestamp for when the document was last updated.

" + } + }, + "documentation":"

The details of a document within an Amazon Q index.

" + }, + "DocumentEnrichmentConditionOperator":{ + "type":"string", + "enum":[ + "GREATER_THAN", + "GREATER_THAN_OR_EQUALS", + "LESS_THAN", + "LESS_THAN_OR_EQUALS", + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "EXISTS", + "NOT_EXISTS", + "BEGINS_WITH" + ] + }, + "DocumentEnrichmentConfiguration":{ + "type":"structure", + "members":{ + "inlineConfigurations":{ + "shape":"InlineDocumentEnrichmentConfigurations", + "documentation":"

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q.

" + }, + "postExtractionHookConfiguration":{"shape":"HookConfiguration"}, + "preExtractionHookConfiguration":{"shape":"HookConfiguration"} + }, + "documentation":"

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

" + }, + "DocumentId":{ + "type":"string", + "max":1825, + "min":1, + "pattern":"^\\P{C}*$" + }, + "DocumentStatus":{ + "type":"string", + "enum":[ + "RECEIVED", + "PROCESSING", + "INDEXED", + "UPDATED", + "FAILED", + "DELETING", + "DELETED", + "DOCUMENT_FAILED_TO_INDEX" + ] + }, + "Documents":{ + "type":"list", + "member":{"shape":"Document"}, + "max":10, + "min":1 + }, + "EligibleDataSource":{ + "type":"structure", + "members":{ + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source.

" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index the data source is attached to.

" + } + }, + "documentation":"

The identifier of the data source Amazon Q will generate responses from.

" + }, + "EligibleDataSources":{ + "type":"list", + "member":{"shape":"EligibleDataSource"}, + "max":5, + "min":0 + }, + "EncryptionConfiguration":{ + "type":"structure", + "members":{ + "kmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The identifier of the KMS key. Amazon Q doesn't support asymmetric keys.

" + } + }, + "documentation":"

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q. Amazon Q doesn't support asymmetric keys.

" + }, + "ErrorCode":{ + "type":"string", + "enum":[ + "InternalError", + "InvalidRequest", + "ResourceInactive", + "ResourceNotFound" + ] + }, + "ErrorDetail":{ + "type":"structure", + "members":{ + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

The code associated with the data source sync error.

" + }, + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The message explaining the data source sync error.

" + } + }, + "documentation":"

Provides information about a data source sync error.

" + }, + "ErrorMessage":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^\\P{C}*$" + }, + "ExampleChatMessage":{ + "type":"string", + "max":350, + "min":0, + "pattern":"^\\P{C}*$" + }, + "ExampleChatMessages":{ + "type":"list", + "member":{"shape":"ExampleChatMessage"}, + "max":5, + "min":0 + }, + "ExecutionId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + }, + "FailedDocument":{ + "type":"structure", + "members":{ + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the Amazon Q data source connector that contains the failed document.

" + }, + "error":{ + "shape":"ErrorDetail", + "documentation":"

An explanation for why the document couldn't be removed from the index.

" + }, + "id":{ + "shape":"DocumentId", + "documentation":"

The identifier of the document that couldn't be removed from the Amazon Q index.

" + } + }, + "documentation":"

A list of documents that could not be removed from an Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

" + }, + "FailedDocuments":{ + "type":"list", + "member":{"shape":"FailedDocument"} + }, + "GetApplicationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application.

", + "location":"uri", + "locationName":"applicationId" + } + } + }, + "GetApplicationResponse":{ + "type":"structure", + "members":{ + "applicationArn":{ + "shape":"ApplicationArn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q application.

" + }, + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application.

" + }, + "attachmentsConfiguration":{ + "shape":"AppliedAttachmentsConfiguration", + "documentation":"

Settings for whether end users can upload files directly during chat.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description for the Amazon Q application.

" + }, + "displayName":{ + "shape":"ApplicationName", + "documentation":"

The name of the Amazon Q application.

" + }, + "encryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q doesn't support asymmetric keys.

" + }, + "error":{ + "shape":"ErrorDetail", + "documentation":"

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

" + }, + "status":{ + "shape":"ApplicationStatus", + "documentation":"

The status of the Amazon Q application.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" + } + } + }, + "GetChatControlsConfigurationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application for which the chat controls are configured.

", + "location":"uri", + "locationName":"applicationId" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForGetTopicConfigurations", + "documentation":"

The maximum number of configured chat controls to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q chat controls configured.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "GetChatControlsConfigurationResponse":{ + "type":"structure", + "members":{ + "blockedPhrases":{ + "shape":"BlockedPhrasesConfiguration", + "documentation":"

The phrases blocked from chat by your chat control configuration.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q chat controls configured.

" + }, + "responseScope":{ + "shape":"ResponseScope", + "documentation":"

The response scope configured for a Amazon Q application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

" + }, + "topicConfigurations":{ + "shape":"TopicConfigurations", + "documentation":"

The topic specific controls configured for a Amazon Q application.

" + } + } + }, + "GetDataSourceRequest":{ + "type":"structure", + "required":[ + "applicationId", + "dataSourceId", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source connector.

", + "location":"uri", + "locationName":"dataSourceId" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identfier of the index used with the data source connector.

", + "location":"uri", + "locationName":"indexId" + } + } + }, + "GetDataSourceResponse":{ + "type":"structure", + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application.

" + }, + "configuration":{ + "shape":"DataSourceConfiguration", + "documentation":"

The details of how the data source connector is configured.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the data source connector was created.

" + }, + "dataSourceArn":{ + "shape":"DataSourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the data source.

" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source connector.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The description for the data source connector.

" + }, + "displayName":{ + "shape":"DataSourceName", + "documentation":"

The name for the data source connector.

" + }, + "documentEnrichmentConfiguration":{"shape":"DocumentEnrichmentConfiguration"}, + "error":{ + "shape":"ErrorDetail", + "documentation":"

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index linked to the data source connector.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

" + }, + "status":{ + "shape":"DataSourceStatus", + "documentation":"

The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

" + }, + "syncSchedule":{ + "shape":"SyncSchedule", + "documentation":"

The schedule for Amazon Q to update the index.

" + }, + "type":{ + "shape":"String", + "documentation":"

The type of the data source connector. For example, S3.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the data source connector was last updated.

" + }, + "vpcConfiguration":{ + "shape":"DataSourceVpcConfiguration", + "documentation":"

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

" + } + } + }, + "GetGroupRequest":{ + "type":"structure", + "required":[ + "applicationId", + "groupName", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application id the group is attached to.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source the group is attached to.

", + "location":"querystring", + "locationName":"dataSourceId" + }, + "groupName":{ + "shape":"GroupName", + "documentation":"

The name of the group.

", + "location":"uri", + "locationName":"groupName" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index the group is attached to.

", + "location":"uri", + "locationName":"indexId" + } + } + }, + "GetGroupResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"GroupStatusDetail", + "documentation":"

The current status of the group.

" + }, + "statusHistory":{ + "shape":"GroupStatusDetails", + "documentation":"

The status history of the group.

" + } + } + }, + "GetIndexRequest":{ + "type":"structure", + "required":[ + "applicationId", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application connected to the index.

", + "location":"uri", + "locationName":"applicationId" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the Amazon Q index you want information on.

", + "location":"uri", + "locationName":"indexId" + } + } + }, + "GetIndexResponse":{ + "type":"structure", + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application associated with the index.

" + }, + "capacityConfiguration":{ + "shape":"IndexCapacityConfiguration", + "documentation":"

The storage capacity units chosen for your Amazon Q index.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the Amazon Q index was created.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The description for the Amazon Q index.

" + }, + "displayName":{ + "shape":"IndexName", + "documentation":"

The name of the Amazon Q index.

" + }, + "documentAttributeConfigurations":{ + "shape":"DocumentAttributeConfigurations", + "documentation":"

Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

" + }, + "error":{ + "shape":"ErrorDetail", + "documentation":"

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

" + }, + "indexArn":{ + "shape":"IndexArn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q index.

" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the Amazon Q index.

" + }, + "indexStatistics":{ + "shape":"IndexStatistics", + "documentation":"

Provides information about the number of documents indexed.

" + }, + "status":{ + "shape":"IndexStatus", + "documentation":"

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the Amazon Q index was last updated.

" + } + } + }, + "GetPluginRequest":{ + "type":"structure", + "required":[ + "applicationId", + "pluginId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application which contains the plugin.

", + "location":"uri", + "locationName":"applicationId" + }, + "pluginId":{ + "shape":"PluginId", + "documentation":"

The identifier of the plugin.

", + "location":"uri", + "locationName":"pluginId" + } + } + }, + "GetPluginResponse":{ + "type":"structure", + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application which contains the plugin.

" + }, + "authConfiguration":{"shape":"PluginAuthConfiguration"}, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The timestamp for when the plugin was created.

" + }, + "displayName":{ + "shape":"PluginName", + "documentation":"

The name of the plugin.

" + }, + "pluginArn":{ + "shape":"PluginArn", + "documentation":"

The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

" + }, + "pluginId":{ + "shape":"PluginId", + "documentation":"

The identifier of the plugin.

" + }, + "serverUrl":{ + "shape":"Url", + "documentation":"

The source URL used for plugin configuration.

" + }, + "state":{ + "shape":"PluginState", + "documentation":"

The current state of the plugin.

" + }, + "type":{ + "shape":"PluginType", + "documentation":"

The type of the plugin.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The timestamp for when the plugin was last updated.

" + } + } + }, + "GetRetrieverRequest":{ + "type":"structure", + "required":[ + "applicationId", + "retrieverId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application using the retriever.

", + "location":"uri", + "locationName":"applicationId" + }, + "retrieverId":{ + "shape":"RetrieverId", + "documentation":"

The identifier of the retriever.

", + "location":"uri", + "locationName":"retrieverId" + } + } + }, + "GetRetrieverResponse":{ + "type":"structure", + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application using the retriever.

" + }, + "configuration":{"shape":"RetrieverConfiguration"}, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the retriever was created.

" + }, + "displayName":{ + "shape":"RetrieverName", + "documentation":"

The name of the retriever.

" + }, + "retrieverArn":{ + "shape":"RetrieverArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

" + }, + "retrieverId":{ + "shape":"RetrieverId", + "documentation":"

The identifier of the retriever.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

" + }, + "status":{ + "shape":"RetrieverStatus", + "documentation":"

The status of the retriever.

" + }, + "type":{ + "shape":"RetrieverType", + "documentation":"

The type of the retriever.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the retriever was last updated.

" + } + } + }, + "GetUserRequest":{ + "type":"structure", + "required":[ + "applicationId", + "userId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application connected to the user.

", + "location":"uri", + "locationName":"applicationId" + }, + "userId":{ + "shape":"String", + "documentation":"

The user email address attached to the user.

", + "location":"uri", + "locationName":"userId" + } + } + }, + "GetUserResponse":{ + "type":"structure", + "members":{ + "userAliases":{ + "shape":"UserAliases", + "documentation":"

A list of user aliases attached to a user.

" + } + } + }, + "GetWebExperienceRequest":{ + "type":"structure", + "required":[ + "applicationId", + "webExperienceId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application linked to the web experience.

", + "location":"uri", + "locationName":"applicationId" + }, + "webExperienceId":{ + "shape":"WebExperienceId", + "documentation":"

The identifier of the Amazon Q web experience.

", + "location":"uri", + "locationName":"webExperienceId" + } + } + }, + "GetWebExperienceResponse":{ + "type":"structure", + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application linked to the web experience.

" + }, + "authenticationConfiguration":{ + "shape":"WebExperienceAuthConfiguration", + "documentation":"

The authentication configuration information for your Amazon Q web experience.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the retriever was created.

" + }, + "defaultEndpoint":{ + "shape":"Url", + "documentation":"

The endpoint of your Amazon Q web experience.

" + }, + "error":{ + "shape":"ErrorDetail", + "documentation":"

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

" + }, + "samplePromptsControlMode":{ + "shape":"WebExperienceSamplePromptsControlMode", + "documentation":"

Determines whether sample prompts are enabled in the web experience for an end user.

" + }, + "status":{ + "shape":"WebExperienceStatus", + "documentation":"

The current status of the Amazon Q web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

" + }, + "subtitle":{ + "shape":"WebExperienceSubtitle", + "documentation":"

The subtitle for your Amazon Q web experience.

" + }, + "title":{ + "shape":"WebExperienceTitle", + "documentation":"

The title for your Amazon Q web experience.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the data source connector was last updated.

" + }, + "webExperienceArn":{ + "shape":"WebExperienceArn", + "documentation":"

The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.

" + }, + "webExperienceId":{ + "shape":"WebExperienceId", + "documentation":"

The identifier of the Amazon Q web experience.

" + }, + "welcomeMessage":{ + "shape":"WebExperienceWelcomeMessage", + "documentation":"

The customized welcome message for end users of an Amazon Q web experience.

" + } + } + }, + "GroupMembers":{ + "type":"structure", + "members":{ + "memberGroups":{ + "shape":"MemberGroups", + "documentation":"

A list of sub groups that belong to a group. For example, the sub groups \"Research\", \"Engineering\", and \"Sales and Marketing\" all belong to the group \"Company\".

" + }, + "memberUsers":{ + "shape":"MemberUsers", + "documentation":"

A list of users that belong to a group. For example, a list of interns all belong to the \"Interns\" group.

" + } + }, + "documentation":"

A list of users or sub groups that belong to a group. This is for generating Amazon Q chat results only from document a user has access to.

" + }, + "GroupName":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^\\P{C}*$" + }, + "GroupStatus":{ + "type":"string", + "enum":[ + "FAILED", + "SUCCEEDED", + "PROCESSING", + "DELETING", + "DELETED" + ] + }, + "GroupStatusDetail":{ + "type":"structure", + "members":{ + "errorDetail":{ + "shape":"ErrorDetail", + "documentation":"

The details of an error associated a group status.

" + }, + "lastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" + }, + "status":{ + "shape":"GroupStatus", + "documentation":"

The status of a group.

" + } + }, + "documentation":"

Provides the details of a group's status.

" + }, + "GroupStatusDetails":{ + "type":"list", + "member":{"shape":"GroupStatusDetail"} + }, + "GroupSummary":{ + "type":"structure", + "members":{ + "groupName":{ + "shape":"GroupName", + "documentation":"

The name of the group the summary information is for.

" + } + }, + "documentation":"

Summary information for groups.

" + }, + "GroupSummaryList":{ + "type":"list", + "member":{"shape":"GroupSummary"} + }, + "HookConfiguration":{ + "type":"structure", + "members":{ + "invocationCondition":{ + "shape":"DocumentAttributeCondition", + "documentation":"

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Q should invoke a function that inserts the current date-time.

" + }, + "lambdaArn":{ + "shape":"LambdaArn", + "documentation":"

The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

" + }, + "s3BucketName":{ + "shape":"S3BucketName", + "documentation":"

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

" + } + }, + "documentation":"

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q.

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

" + }, + "Index":{ + "type":"structure", + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the index was created.

" + }, + "displayName":{ + "shape":"IndexName", + "documentation":"

The name of the index.

" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier for the index.

" + }, + "status":{ + "shape":"IndexStatus", + "documentation":"

The current status of the index. When the status is ACTIVE, the index is ready.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the index was last updated.

" + } + }, + "documentation":"

Summary information for your Amazon Q index.

" + }, + "IndexArn":{ + "type":"string", + "max":1284, + "min":0, + "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + }, + "IndexCapacityConfiguration":{ + "type":"structure", + "members":{ + "units":{ + "shape":"IndexCapacityInteger", + "documentation":"

The number of storage units configured for an Amazon Q index.

" + } + }, + "documentation":"

Provides information about index capacity configuration.

" + }, + "IndexCapacityInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "IndexId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + }, + "IndexName":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + }, + "IndexStatistics":{ + "type":"structure", + "members":{ + "textDocumentStatistics":{ + "shape":"TextDocumentStatistics", + "documentation":"

The number of documents indexed.

" + } + }, + "documentation":"

Provides information about the number of documents in an index.

" + }, + "IndexStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ] + }, + "IndexedTextBytes":{ + "type":"long", + "box":true, + "min":0 + }, + "IndexedTextDocument":{ + "type":"integer", + "box":true, + "min":0 + }, + "Indices":{ + "type":"list", + "member":{"shape":"Index"} + }, + "InlineDocumentEnrichmentConfiguration":{ + "type":"structure", + "members":{ + "condition":{"shape":"DocumentAttributeCondition"}, + "documentContentOperator":{ + "shape":"DocumentContentOperator", + "documentation":"

TRUE to delete content if the condition used for the target attribute is met.

" + }, + "target":{"shape":"DocumentAttributeTarget"} + }, + "documentation":"

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q.

To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration .

For more information, see Custom document enrichment.

" + }, + "InlineDocumentEnrichmentConfigurations":{ + "type":"list", + "member":{"shape":"InlineDocumentEnrichmentConfiguration"}, + "max":100, + "min":1 + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

An issue occurred with the internal server used for your Amazon Q service. Wait some minutes and try again, or contact Support for help.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "KendraIndexConfiguration":{ + "type":"structure", + "required":["indexId"], + "members":{ + "indexId":{ + "shape":"KendraIndexId", + "documentation":"

The identifier of the Amazon Kendra index.

" + } + }, + "documentation":"

Stores an Amazon Kendra index as a retriever.

" + }, + "KendraIndexId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + }, + "KmsKeyId":{ + "type":"string", + "max":2048, + "min":1, + "sensitive":true + }, + "LambdaArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$" + }, + "LicenseNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ListApplicationsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResultsIntegerForListApplications", + "documentation":"

The maximum number of Amazon Q applications to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q applications.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListApplicationsResponse":{ + "type":"structure", + "members":{ + "applications":{ + "shape":"Applications", + "documentation":"

An array of summary information on the configuration of one or more Amazon Q applications.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Q returns this token. You can use this token in a subsequent request to retrieve the next set of applications.

" + } + } + }, + "ListConversationsRequest":{ + "type":"structure", + "required":[ + "applicationId", + "userId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application.

", + "location":"uri", + "locationName":"applicationId" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForListConversations", + "documentation":"

The maximum number of Amazon Q conversations to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q conversations.

", + "location":"querystring", + "locationName":"nextToken" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The identifier of the user involved in the Amazon Q web experience conversation.

", + "location":"querystring", + "locationName":"userId" + } + } + }, + "ListConversationsResponse":{ + "type":"structure", + "members":{ + "conversations":{ + "shape":"Conversations", + "documentation":"

An array of summary information on the configuration of one or more Amazon Q web experiences.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.

" + } + } + }, + "ListDataSourceSyncJobsRequest":{ + "type":"structure", + "required":[ + "applicationId", + "dataSourceId", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application connected to the data source.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source connector.

", + "location":"uri", + "locationName":"dataSourceId" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The end time of the data source connector sync.

", + "location":"querystring", + "locationName":"endTime" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index used with the Amazon Q data source connector.

", + "location":"uri", + "locationName":"indexId" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForListDataSourcesSyncJobs", + "documentation":"

The maximum number of synchronization jobs to return in the response.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incpmplete because there is more data to retriever, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.

", + "location":"querystring", + "locationName":"nextToken" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the data source connector sync.

", + "location":"querystring", + "locationName":"startTime" + }, + "statusFilter":{ + "shape":"DataSourceSyncJobStatus", + "documentation":"

Only returns synchronization jobs with the Status field equal to the specified status.

", + "location":"querystring", + "locationName":"syncStatus" + } + } + }, + "ListDataSourceSyncJobsResponse":{ + "type":"structure", + "members":{ + "history":{ + "shape":"DataSourceSyncJobs", + "documentation":"

A history of synchronization jobs for the data source connector.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Q returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.

" + } + } + }, + "ListDataSourcesRequest":{ + "type":"structure", + "required":[ + "applicationId", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application linked to the data source connectors.

", + "location":"uri", + "locationName":"applicationId" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index used with one or more data source connectors.

", + "location":"uri", + "locationName":"indexId" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForListDataSources", + "documentation":"

The maximum number of data source connectors to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q data source connectors.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListDataSourcesResponse":{ + "type":"structure", + "members":{ + "dataSources":{ + "shape":"DataSources", + "documentation":"

An array of summary information for one or more data source connector.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Q returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.

" + } + } + }, + "ListDocumentsRequest":{ + "type":"structure", + "required":[ + "applicationId", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application id the documents are attached to.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceIds":{ + "shape":"DataSourceIds", + "documentation":"

The identifier of the data sources the documents are attached to.

", + "location":"querystring", + "locationName":"dataSourceIds" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index the documents are attached to.

", + "location":"uri", + "locationName":"indexId" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForListDocuments", + "documentation":"

The maximum number of documents to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListDocumentsResponse":{ + "type":"structure", + "members":{ + "documentDetailList":{ + "shape":"DocumentDetailList", + "documentation":"

A list of document details.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

" + } + } + }, + "ListGroupsRequest":{ + "type":"structure", + "required":[ + "applicationId", + "indexId", + "updatedEarlierThan" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application for getting a list of groups mapped to users.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source for getting a list of groups mapped to users.

", + "location":"querystring", + "locationName":"dataSourceId" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index for getting a list of groups mapped to users.

", + "location":"uri", + "locationName":"indexId" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForListGroupsRequest", + "documentation":"

The maximum number of returned groups that are mapped to users.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the previous response was incomplete (because there is more data to retrieve), Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.

", + "location":"querystring", + "locationName":"nextToken" + }, + "updatedEarlierThan":{ + "shape":"Timestamp", + "documentation":"

The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

", + "location":"querystring", + "locationName":"updatedEarlierThan" + } + } + }, + "ListGroupsResponse":{ + "type":"structure", + "members":{ + "items":{ + "shape":"GroupSummaryList", + "documentation":"

Summary information for list of groups that are mapped to users.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Q returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.

" + } + } + }, + "ListIndicesRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application connected to the index.

", + "location":"uri", + "locationName":"applicationId" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForListIndices", + "documentation":"

The maximum number of indices to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q indices.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListIndicesResponse":{ + "type":"structure", + "members":{ + "indices":{ + "shape":"Indices", + "documentation":"

An array of information on the items in one or more indexes.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Q returns this token that you can use in the subsequent request to retrieve the next set of indexes.

" + } + } + }, + "ListMessagesRequest":{ + "type":"structure", + "required":[ + "applicationId", + "conversationId", + "userId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier for the Amazon Q application.

", + "location":"uri", + "locationName":"applicationId" + }, + "conversationId":{ + "shape":"ConversationId", + "documentation":"

The identifier of the Amazon Q web experience conversation.

", + "location":"uri", + "locationName":"conversationId" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForListMessages", + "documentation":"

The maximum number of messages to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the number of retrievers returned exceeds maxResults, Amazon Q returns a next token as a pagination token to retrieve the next set of messages.

", + "location":"querystring", + "locationName":"nextToken" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The identifier of the user involved in the Amazon Q web experience conversation.

", + "location":"querystring", + "locationName":"userId" + } + } + }, + "ListMessagesResponse":{ + "type":"structure", + "members":{ + "messages":{ + "shape":"Messages", + "documentation":"

An array of information on one or more messages.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.

" + } + } + }, + "ListPluginsRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application the plugin is attached to.

", + "location":"uri", + "locationName":"applicationId" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForListPlugins", + "documentation":"

The maximum number of documents to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListPluginsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.

" + }, + "plugins":{ + "shape":"Plugins", + "documentation":"

Information about a configured plugin.

" + } + } + }, + "ListRetrieversRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application using the retriever.

", + "location":"uri", + "locationName":"applicationId" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForListRetrieversRequest", + "documentation":"

The maximum number of retrievers returned.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the number of retrievers returned exceeds maxResults, Amazon Q returns a next token as a pagination token to retrieve the next set of retrievers.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListRetrieversResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of retrievers.

" + }, + "retrievers":{ + "shape":"Retrievers", + "documentation":"

An array of summary information for one or more retrievers.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceARN"], + "members":{ + "resourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q application or data source to get a list of tags for.

", + "location":"uri", + "locationName":"resourceARN" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"

A list of tags associated with the Amazon Q application or data source.

" + } + } + }, + "ListWebExperiencesRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application linked to the listed web experiences.

", + "location":"uri", + "locationName":"applicationId" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForListWebExperiencesRequest", + "documentation":"

The maximum number of Amazon Q Web Experiences to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q conversations.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListWebExperiencesResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.

" + }, + "webExperiences":{ + "shape":"WebExperiences", + "documentation":"

An array of summary information for one or more Amazon Q experiences.

" + } + } + }, + "Long":{ + "type":"long", + "box":true + }, + "MaxResultsIntegerForGetTopicConfigurations":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "MaxResultsIntegerForListApplications":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxResultsIntegerForListConversations":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxResultsIntegerForListDataSources":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "MaxResultsIntegerForListDataSourcesSyncJobs":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "MaxResultsIntegerForListDocuments":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxResultsIntegerForListGroupsRequest":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "MaxResultsIntegerForListIndices":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxResultsIntegerForListMessages":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxResultsIntegerForListPlugins":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "MaxResultsIntegerForListRetrieversRequest":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "MaxResultsIntegerForListWebExperiencesRequest":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MemberGroup":{ + "type":"structure", + "required":["groupName"], + "members":{ + "groupName":{ + "shape":"GroupName", + "documentation":"

The name of the sub group.

" + }, + "type":{ + "shape":"MembershipType", + "documentation":"

The type of the sub group.

" + } + }, + "documentation":"

The sub groups that belong to a group.

" + }, + "MemberGroups":{ + "type":"list", + "member":{"shape":"MemberGroup"}, + "max":1000, + "min":1 + }, + "MemberRelation":{ + "type":"string", + "enum":[ + "AND", + "OR" + ] + }, + "MemberUser":{ + "type":"structure", + "required":["userId"], + "members":{ + "type":{ + "shape":"MembershipType", + "documentation":"

The type of the user.

" + }, + "userId":{ + "shape":"DataSourceUserId", + "documentation":"

The identifier of the user you want to map to a group.

" + } + }, + "documentation":"

The users that belong to a group.

" + }, + "MemberUsers":{ + "type":"list", + "member":{"shape":"MemberUser"}, + "max":1000, + "min":1 + }, + "MembershipType":{ + "type":"string", + "enum":[ + "INDEX", + "DATASOURCE" + ] + }, + "Message":{ + "type":"structure", + "members":{ + "actionExecution":{"shape":"ActionExecution"}, + "actionReview":{"shape":"ActionReview"}, + "attachments":{ + "shape":"AttachmentsOutput", + "documentation":"

A file directly uploaded into an Amazon Q web experience chat.

" + }, + "body":{ + "shape":"MessageBody", + "documentation":"

The content of the Amazon Q web experience message.

" + }, + "messageId":{ + "shape":"String", + "documentation":"

The identifier of the Amazon Q web experience message.

" + }, + "sourceAttribution":{ + "shape":"SourceAttributions", + "documentation":"

The source documents used to generate Amazon Q web experience message.

" + }, + "time":{ + "shape":"Timestamp", + "documentation":"

The timestamp of the first Amazon Q web experience message.

" + }, + "type":{ + "shape":"MessageType", + "documentation":"

The type of Amazon Q message, whether HUMAN or AI generated.

" + } + }, + "documentation":"

A message in an Amazon Q web experience.

" + }, + "MessageBody":{ + "type":"string", + "max":1000, + "min":0, + "pattern":"^\\P{C}*$}$" + }, + "MessageId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + }, + "MessageType":{ + "type":"string", + "enum":[ + "USER", + "SYSTEM" + ] + }, + "MessageUsefulness":{ + "type":"string", + "enum":[ + "USEFUL", + "NOT_USEFUL" + ] + }, + "MessageUsefulnessComment":{ + "type":"string", + "max":1000, + "min":0, + "pattern":"^\\P{C}*$" + }, + "MessageUsefulnessFeedback":{ + "type":"structure", + "required":[ + "submittedAt", + "usefulness" + ], + "members":{ + "comment":{ + "shape":"MessageUsefulnessComment", + "documentation":"

A comment given by an end user on the usefulness of an AI-generated chat message.

" + }, + "reason":{ + "shape":"MessageUsefulnessReason", + "documentation":"

The reason for a usefulness rating.

" + }, + "submittedAt":{ + "shape":"Timestamp", + "documentation":"

The timestamp for when the feedback was submitted.

" + }, + "usefulness":{ + "shape":"MessageUsefulness", + "documentation":"

The usefulness value assigned by an end user to a message.

" + } + }, + "documentation":"

End user feedback on an AI-generated web experience chat message usefulness.

" + }, + "MessageUsefulnessReason":{ + "type":"string", + "enum":[ + "NOT_FACTUALLY_CORRECT", + "HARMFUL_OR_UNSAFE", + "INCORRECT_OR_MISSING_SOURCES", + "NOT_HELPFUL", + "FACTUALLY_CORRECT", + "COMPLETE", + "RELEVANT_SOURCES", + "HELPFUL" + ] + }, + "Messages":{ + "type":"list", + "member":{"shape":"Message"} + }, + "MetricValue":{ + "type":"string", + "pattern":"^(([1-9][0-9]*)|0)$" + }, + "NativeIndexConfiguration":{ + "type":"structure", + "required":["indexId"], + "members":{ + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier for the Amazon Q index.

" + } + }, + "documentation":"

Configuration information for an Amazon Q index.

" + }, + "NextToken":{ + "type":"string", + "max":800, + "min":1 + }, + "OAuth2ClientCredentialConfiguration":{ + "type":"structure", + "required":[ + "roleArn", + "secretArn" + ], + "members":{ + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of an IAM role used by Amazon Q to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

" + }, + "secretArn":{ + "shape":"SecretArn", + "documentation":"

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

" + } + }, + "documentation":"

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

" + }, + "Plugin":{ + "type":"structure", + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The timestamp for when the plugin was created.

" + }, + "displayName":{ + "shape":"PluginName", + "documentation":"

The name of the plugin.

" + }, + "pluginId":{ + "shape":"PluginId", + "documentation":"

The identifier of the plugin.

" + }, + "serverUrl":{ + "shape":"Url", + "documentation":"

The plugin server URL used for configuration.

" + }, + "state":{ + "shape":"PluginState", + "documentation":"

The current status of the plugin.

" + }, + "type":{ + "shape":"PluginType", + "documentation":"

The type of the plugin.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The timestamp for when the plugin was last updated.

" + } + }, + "documentation":"

Information about an Amazon Q plugin and its configuration.

" + }, + "PluginArn":{ + "type":"string", + "max":1284, + "min":0, + "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + }, + "PluginAuthConfiguration":{ + "type":"structure", + "members":{ + "basicAuthConfiguration":{ + "shape":"BasicAuthConfiguration", + "documentation":"

Information about the basic authentication credentials used to configure a plugin.

" + }, + "oAuth2ClientCredentialConfiguration":{ + "shape":"OAuth2ClientCredentialConfiguration", + "documentation":"

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

" + } + }, + "documentation":"

Authentication configuration information for an Amazon Q plugin.

", + "union":true + }, + "PluginId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + }, + "PluginName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + }, + "PluginState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "PluginType":{ + "type":"string", + "enum":[ + "SERVICE_NOW", + "SALESFORCE", + "JIRA", + "ZENDESK" + ] + }, + "Plugins":{ + "type":"list", + "member":{"shape":"Plugin"} + }, + "Principal":{ + "type":"structure", + "members":{ + "group":{ + "shape":"PrincipalGroup", + "documentation":"

The group associated with the principal.

" + }, + "user":{ + "shape":"PrincipalUser", + "documentation":"

The user associated with the principal.

" + } + }, + "documentation":"

Provides user and group information used for filtering documents to use for generating Amazon Q conversation responses.

", + "union":true + }, + "PrincipalGroup":{ + "type":"structure", + "required":["access"], + "members":{ + "access":{ + "shape":"ReadAccessType", + "documentation":"

Provides information about whether to allow or deny access to the principal.

" + }, + "membershipType":{ + "shape":"MembershipType", + "documentation":"

The type of group.

" + }, + "name":{ + "shape":"GroupName", + "documentation":"

The name of the group.

" + } + }, + "documentation":"

Provides information about a group associated with the principal.

" + }, + "PrincipalUser":{ + "type":"structure", + "required":["access"], + "members":{ + "access":{ + "shape":"ReadAccessType", + "documentation":"

Provides information about whether to allow or deny access to the principal.

" + }, + "id":{ + "shape":"UserId", + "documentation":"

The identifier of the user.

" + }, + "membershipType":{ + "shape":"MembershipType", + "documentation":"

The type of group.

" + } + }, + "documentation":"

Provides information about a user associated with a principal.

" + }, + "Principals":{ + "type":"list", + "member":{"shape":"Principal"} + }, + "PutFeedbackRequest":{ + "type":"structure", + "required":[ + "applicationId", + "conversationId", + "messageId", + "userId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application associated with the feedback.

", + "location":"uri", + "locationName":"applicationId" + }, + "conversationId":{ + "shape":"ConversationId", + "documentation":"

The identifier of the conversation the feedback is attached to.

", + "location":"uri", + "locationName":"conversationId" + }, + "messageCopiedAt":{ + "shape":"Timestamp", + "documentation":"

The timestamp for when the feedback was recorded.

" + }, + "messageId":{ + "shape":"SystemMessageId", + "documentation":"

The identifier of the chat message that the feedback was given for.

", + "location":"uri", + "locationName":"messageId" + }, + "messageUsefulness":{ + "shape":"MessageUsefulnessFeedback", + "documentation":"

The feedback usefulness value given by the user to the chat message.

" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The identifier of the user giving the feedback.

", + "location":"querystring", + "locationName":"userId" + } + } + }, + "PutGroupRequest":{ + "type":"structure", + "required":[ + "applicationId", + "groupMembers", + "groupName", + "indexId", + "type" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application in which the user and group mapping belongs.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups \"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, \"Sales and Marketing\" team only needs access to customer-related documents stored in Salesforce.

" + }, + "groupMembers":{"shape":"GroupMembers"}, + "groupName":{ + "shape":"GroupName", + "documentation":"

The list that contains your users or sub groups that belong the same group. For example, the group \"Company\" includes the user \"CEO\" and the sub groups \"Research\", \"Engineering\", and \"Sales and Marketing\".

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index in which you want to map users to their groups.

", + "location":"uri", + "locationName":"indexId" + }, + "type":{ + "shape":"MembershipType", + "documentation":"

The type of the group.

" + } + } + }, + "PutGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "ReadAccessType":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The message describing a ResourceNotFoundException.

" + }, + "resourceId":{ + "shape":"String", + "documentation":"

The identifier of the resource affected.

" + }, + "resourceType":{ + "shape":"String", + "documentation":"

The type of the resource affected.

" + } + }, + "documentation":"

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResponseScope":{ + "type":"string", + "enum":[ + "ENTERPRISE_CONTENT_ONLY", + "EXTENDED_KNOWLEDGE_ENABLED" + ] + }, + "Retriever":{ + "type":"structure", + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application using the retriever.

" + }, + "displayName":{ + "shape":"RetrieverName", + "documentation":"

The name of your retriever.

" + }, + "retrieverId":{ + "shape":"RetrieverId", + "documentation":"

The identifier of the retriever used by your Amazon Q application.

" + }, + "status":{ + "shape":"RetrieverStatus", + "documentation":"

The status of your retriever.

" + }, + "type":{ + "shape":"RetrieverType", + "documentation":"

The type of your retriever.

" + } + }, + "documentation":"

Summary information for the retriever used for your Amazon Q application.

" + }, + "RetrieverArn":{ + "type":"string", + "max":1284, + "min":0, + "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + }, + "RetrieverConfiguration":{ + "type":"structure", + "members":{ + "kendraIndexConfiguration":{ + "shape":"KendraIndexConfiguration", + "documentation":"

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.

" + }, + "nativeIndexConfiguration":{ + "shape":"NativeIndexConfiguration", + "documentation":"

Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.

" + } + }, + "documentation":"

Provides information on how the retriever used for your Amazon Q application is configured.

", + "union":true + }, + "RetrieverId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + }, + "RetrieverName":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + }, + "RetrieverStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "FAILED" + ] + }, + "RetrieverType":{ + "type":"string", + "enum":[ + "NATIVE_INDEX", + "KENDRA_INDEX" + ] + }, + "Retrievers":{ + "type":"list", + "member":{"shape":"Retriever"} + }, + "RoleArn":{ + "type":"string", + "max":1284, + "min":0, + "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + }, + "Rule":{ + "type":"structure", + "required":["ruleType"], + "members":{ + "excludedUsersAndGroups":{ + "shape":"UsersAndGroups", + "documentation":"

Users and groups to be excluded from a rule.

" + }, + "includedUsersAndGroups":{ + "shape":"UsersAndGroups", + "documentation":"

Users and groups to be included in a rule.

" + }, + "ruleConfiguration":{ + "shape":"RuleConfiguration", + "documentation":"

The configuration information for a rule.

" + }, + "ruleType":{ + "shape":"RuleType", + "documentation":"

The type fo rule.

" + } + }, + "documentation":"

Guardrail rules for an Amazon Q application. Amazon Q supports only one rule at a time.

" + }, + "RuleConfiguration":{ + "type":"structure", + "members":{ + "contentBlockerRule":{ + "shape":"ContentBlockerRule", + "documentation":"

A rule for configuring how Amazon Q responds when it encounters a a blocked topic.

" + }, + "contentRetrievalRule":{"shape":"ContentRetrievalRule"} + }, + "documentation":"

Provides configuration information about a rule.

", + "union":true + }, + "RuleType":{ + "type":"string", + "enum":[ + "CONTENT_BLOCKER_RULE", + "CONTENT_RETRIEVAL_RULE" + ] + }, + "Rules":{ + "type":"list", + "member":{"shape":"Rule"}, + "max":10, + "min":0 + }, + "S3":{ + "type":"structure", + "required":[ + "bucket", + "key" + ], + "members":{ + "bucket":{ + "shape":"S3BucketName", + "documentation":"

The name of the S3 bucket that contains the file.

" + }, + "key":{ + "shape":"S3ObjectKey", + "documentation":"

The name of the file.

" + } + }, + "documentation":"

Information required for Amazon Q to find a specific file in an Amazon S3 bucket.

" + }, + "S3BucketName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + }, + "S3ObjectKey":{ + "type":"string", + "max":1024, + "min":1 + }, + "SamlAttribute":{ + "type":"string", + "max":256, + "min":1 + }, + "SamlConfiguration":{ + "type":"structure", + "required":[ + "metadataXML", + "roleArn", + "userIdAttribute" + ], + "members":{ + "metadataXML":{ + "shape":"SamlMetadataXML", + "documentation":"

The metadata XML that your IdP generated.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q web experience, containing the relevant Amazon Q permissions for conversing with Amazon Q.

" + }, + "userGroupAttribute":{ + "shape":"SamlAttribute", + "documentation":"

The group attribute name in your IdP that maps to user groups.

" + }, + "userIdAttribute":{ + "shape":"SamlAttribute", + "documentation":"

The user attribute name in your IdP that maps to the user email.

" + } + }, + "documentation":"

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q needs to deploy a Amazon Q web experience.

" + }, + "SamlMetadataXML":{ + "type":"string", + "max":10000000, + "min":1000, + "pattern":"^.*$" + }, + "SecretArn":{ + "type":"string", + "max":1284, + "min":0, + "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + }, + "SecurityGroupId":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[-0-9a-zA-Z]+$" + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":10, + "min":1 + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The message describing a ServiceQuotaExceededException.

" + }, + "resourceId":{ + "shape":"String", + "documentation":"

The identifier of the resource affected.

" + }, + "resourceType":{ + "shape":"String", + "documentation":"

The type of the resource affected.

" + } + }, + "documentation":"

You have exceeded the set limits for your Amazon Q service.

", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SourceAttribution":{ + "type":"structure", + "members":{ + "citationNumber":{ + "shape":"Integer", + "documentation":"

The number attached to a citation in an Amazon Q generated response.

" + }, + "snippet":{ + "shape":"String", + "documentation":"

The content extract from the document on which the generated response is based.

" + }, + "textMessageSegments":{ + "shape":"TextSegmentList", + "documentation":"

A text extract from a source document that is used for source attribution.

" + }, + "title":{ + "shape":"String", + "documentation":"

The title of the document which is the source for the Amazon Q generated response.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" + }, + "url":{ + "shape":"String", + "documentation":"

The URL of the document which is the source for the Amazon Q generated response.

" + } + }, + "documentation":"

The documents used to generate an Amazon Q web experience response.

" + }, + "SourceAttributions":{ + "type":"list", + "member":{"shape":"SourceAttribution"} + }, + "StartDataSourceSyncJobRequest":{ + "type":"structure", + "required":[ + "applicationId", + "dataSourceId", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of Amazon Q application the data source is connected to.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source connector.

", + "location":"uri", + "locationName":"dataSourceId" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index used with the data source connector.

", + "location":"uri", + "locationName":"indexId" + } + } + }, + "StartDataSourceSyncJobResponse":{ + "type":"structure", + "members":{ + "executionId":{ + "shape":"ExecutionId", + "documentation":"

The identifier for a particular synchronization job.

" + } + } + }, + "Status":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "StopDataSourceSyncJobRequest":{ + "type":"structure", + "required":[ + "applicationId", + "dataSourceId", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application that the data source is connected to.

", + "location":"uri", + "locationName":"applicationId" + }, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source connector.

", + "location":"uri", + "locationName":"dataSourceId" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index used with the Amazon Q data source connector.

", + "location":"uri", + "locationName":"indexId" + } + } + }, + "StopDataSourceSyncJobResponse":{ + "type":"structure", + "members":{ + } + }, + "String":{ + "type":"string", + "max":2048, + "min":1 + }, + "SubnetId":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[-0-9a-zA-Z]+$" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"} + }, + "SyncSchedule":{ + "type":"string", + "max":998, + "min":0, + "pattern":"^\\P{C}*$" + }, + "SystemMessageId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + }, + "SystemMessageOverride":{ + "type":"string", + "max":350, + "min":0, + "pattern":"^\\P{C}*$" + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q application or data source.

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

The value associated with the tag. The value may be an empty string but it can't be null.

" + } + }, + "documentation":"

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceARN", + "tags" + ], + "members":{ + "resourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q application or data source to tag.

", + "location":"uri", + "locationName":"resourceARN" + }, + "tags":{ + "shape":"Tags", + "documentation":"

A list of tag keys to add to the Amazon Q application or data source. If a tag already exists, the existing value is replaced with the new value.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, + "TextDocumentStatistics":{ + "type":"structure", + "members":{ + "indexedTextBytes":{ + "shape":"IndexedTextBytes", + "documentation":"

The total size, in bytes, of the indexed documents.

" + }, + "indexedTextDocumentCount":{ + "shape":"IndexedTextDocument", + "documentation":"

The number of text documents indexed.

" + } + }, + "documentation":"

Provides information about text documents in an index.

" + }, + "TextSegment":{ + "type":"structure", + "members":{ + "beginOffset":{ + "shape":"Integer", + "documentation":"

The zero-based location in the response string where the source attribution starts.

" + }, + "endOffset":{ + "shape":"Integer", + "documentation":"

The zero-based location in the response string where the source attribution ends.

" + } + }, + "documentation":"

Provides information about a text extract in a chat response that can be attributed to a source document.

" + }, + "TextSegmentList":{ + "type":"list", + "member":{"shape":"TextSegment"} + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request was denied due to throttling. Reduce the number of requests and try again.

", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "Title":{ + "type":"string", + "max":1024, + "min":1 + }, + "TopicConfiguration":{ + "type":"structure", + "required":[ + "name", + "rules" + ], + "members":{ + "description":{ + "shape":"TopicDescription", + "documentation":"

A description for your topic control configuration. Use this outline how the large language model (LLM) should use this topic control configuration.

" + }, + "exampleChatMessages":{ + "shape":"ExampleChatMessages", + "documentation":"

A list of example phrases that you expect the end user to use in relation to the topic.

" + }, + "name":{ + "shape":"TopicConfigurationName", + "documentation":"

A name for your topic control configuration.

" + }, + "rules":{ + "shape":"Rules", + "documentation":"

Rules defined for a topic configuration.

" + } + }, + "documentation":"

The topic specific controls configured for an Amazon Q application.

" + }, + "TopicConfigurationName":{ + "type":"string", + "max":36, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{0,35}$" + }, + "TopicConfigurations":{ + "type":"list", + "member":{"shape":"TopicConfiguration"}, + "max":10, + "min":0 + }, + "TopicDescription":{ + "type":"string", + "max":350, + "min":0, + "pattern":"^\\P{C}*$" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceARN", + "tagKeys" + ], + "members":{ + "resourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q application, or data source to remove the tag from.

", + "location":"uri", + "locationName":"resourceARN" + }, + "tagKeys":{ + "shape":"TagKeys", + "documentation":"

A list of tag keys to remove from the Amazon Q application or data source. If a tag key does not exist on the resource, it is ignored.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateApplicationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application.

", + "location":"uri", + "locationName":"applicationId" + }, + "attachmentsConfiguration":{ + "shape":"AttachmentsConfiguration", + "documentation":"

An option to allow end users to upload files directly during chat.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description for the Amazon Q application.

" + }, + "displayName":{ + "shape":"ApplicationName", + "documentation":"

A name for the Amazon Q application.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q permission to access Amazon CloudWatch logs and metrics.

" + } + } + }, + "UpdateApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateChatControlsConfigurationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application for which the chat controls are configured.

", + "location":"uri", + "locationName":"applicationId" + }, + "blockedPhrasesConfigurationUpdate":{ + "shape":"BlockedPhrasesConfigurationUpdate", + "documentation":"

The phrases blocked from chat by your chat control configuration.

" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A token that you provide to identify the request to update a Amazon Q application chat configuration.

", + "idempotencyToken":true + }, + "responseScope":{ + "shape":"ResponseScope", + "documentation":"

The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

" + }, + "topicConfigurationsToCreateOrUpdate":{ + "shape":"TopicConfigurations", + "documentation":"

The configured topic specific chat controls you want to update.

" + }, + "topicConfigurationsToDelete":{ + "shape":"TopicConfigurations", + "documentation":"

The configured topic specific chat controls you want to delete.

" + } + } + }, + "UpdateChatControlsConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDataSourceRequest":{ + "type":"structure", + "required":[ + "applicationId", + "dataSourceId", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application the data source is attached to.

", + "location":"uri", + "locationName":"applicationId" + }, + "configuration":{"shape":"DataSourceConfiguration"}, + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source connector.

", + "location":"uri", + "locationName":"dataSourceId" + }, + "description":{ + "shape":"Description", + "documentation":"

The description of the data source connector.

" + }, + "displayName":{ + "shape":"DataSourceName", + "documentation":"

A name of the data source connector.

" + }, + "documentEnrichmentConfiguration":{"shape":"DocumentEnrichmentConfiguration"}, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index attached to the data source connector.

", + "location":"uri", + "locationName":"indexId" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

" + }, + "syncSchedule":{ + "shape":"SyncSchedule", + "documentation":"

The chosen update frequency for your data source.

" + }, + "vpcConfiguration":{"shape":"DataSourceVpcConfiguration"} + } + }, + "UpdateDataSourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateIndexRequest":{ + "type":"structure", + "required":[ + "applicationId", + "indexId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application connected to the index.

", + "location":"uri", + "locationName":"applicationId" + }, + "capacityConfiguration":{ + "shape":"IndexCapacityConfiguration", + "documentation":"

The storage capacity units you want to provision for your Amazon Q index. You can add and remove capacity to fit your usage needs.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The description of the Amazon Q index.

" + }, + "displayName":{ + "shape":"ApplicationName", + "documentation":"

The name of the Amazon Q index.

" + }, + "documentAttributeConfigurations":{ + "shape":"DocumentAttributeConfigurations", + "documentation":"

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the Amazon Q index.

", + "location":"uri", + "locationName":"indexId" + } + } + }, + "UpdateIndexResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdatePluginRequest":{ + "type":"structure", + "required":[ + "applicationId", + "pluginId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application the plugin is attached to.

", + "location":"uri", + "locationName":"applicationId" + }, + "authConfiguration":{ + "shape":"PluginAuthConfiguration", + "documentation":"

The authentication configuration the plugin is using.

" + }, + "displayName":{ + "shape":"PluginName", + "documentation":"

The name of the plugin.

" + }, + "pluginId":{ + "shape":"PluginId", + "documentation":"

The identifier of the plugin.

", + "location":"uri", + "locationName":"pluginId" + }, + "serverUrl":{ + "shape":"Url", + "documentation":"

The source URL used for plugin configuration.

" + }, + "state":{ + "shape":"PluginState", + "documentation":"

The status of the plugin.

" + } + } + }, + "UpdatePluginResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateRetrieverRequest":{ + "type":"structure", + "required":[ + "applicationId", + "retrieverId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of your Amazon Q application.

", + "location":"uri", + "locationName":"applicationId" + }, + "configuration":{"shape":"RetrieverConfiguration"}, + "displayName":{ + "shape":"RetrieverName", + "documentation":"

The name of your retriever.

" + }, + "retrieverId":{ + "shape":"RetrieverId", + "documentation":"

The identifier of your retriever.

", + "location":"uri", + "locationName":"retrieverId" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

" + } + } + }, + "UpdateRetrieverResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateUserRequest":{ + "type":"structure", + "required":[ + "applicationId", + "userId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the application the user is attached to.

", + "location":"uri", + "locationName":"applicationId" + }, + "userAliasesToDelete":{ + "shape":"UserAliases", + "documentation":"

The user aliases attached to the user id that are to be deleted.

" + }, + "userAliasesToUpdate":{ + "shape":"UserAliases", + "documentation":"

The user aliases attached to the user id that are to be updated.

" + }, + "userId":{ + "shape":"String", + "documentation":"

The email id attached to the user.

", + "location":"uri", + "locationName":"userId" + } + } + }, + "UpdateUserResponse":{ + "type":"structure", + "members":{ + "userAliasesAdded":{ + "shape":"UserAliases", + "documentation":"

The user aliases that have been to be added to a user id.

" + }, + "userAliasesDeleted":{ + "shape":"UserAliases", + "documentation":"

The user aliases that have been deleted from a user id.

" + }, + "userAliasesUpdated":{ + "shape":"UserAliases", + "documentation":"

The user aliases attached to a user id that have been updated.

" + } + } + }, + "UpdateWebExperienceRequest":{ + "type":"structure", + "required":[ + "applicationId", + "webExperienceId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The identifier of the Amazon Q application attached to the web experience.

", + "location":"uri", + "locationName":"applicationId" + }, + "authenticationConfiguration":{ + "shape":"WebExperienceAuthConfiguration", + "documentation":"

The authentication configuration of the Amazon Q web experience.

" + }, + "samplePromptsControlMode":{ + "shape":"WebExperienceSamplePromptsControlMode", + "documentation":"

Determines whether sample prompts are enabled in the web experience for an end user.

" + }, + "subtitle":{ + "shape":"WebExperienceSubtitle", + "documentation":"

The subtitle of the Amazon Q web experience.

" + }, + "title":{ + "shape":"WebExperienceTitle", + "documentation":"

The title of the Amazon Q web experience.

" + }, + "webExperienceId":{ + "shape":"WebExperienceId", + "documentation":"

The identifier of the Amazon Q web experience.

", + "location":"uri", + "locationName":"webExperienceId" + }, + "welcomeMessage":{ + "shape":"WebExperienceWelcomeMessage", + "documentation":"

A customized welcome message for an end user in an Amazon Q web experience.

" + } + } + }, + "UpdateWebExperienceResponse":{ + "type":"structure", + "members":{ + } + }, + "Url":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^(https?|ftp|file)://([^\\s]*)$" + }, + "UserAlias":{ + "type":"structure", + "required":["userId"], + "members":{ + "dataSourceId":{ + "shape":"DataSourceId", + "documentation":"

The identifier of the data source that the user aliases are associated with.

" + }, + "indexId":{ + "shape":"IndexId", + "documentation":"

The identifier of the index that the user aliases are associated with.

" + }, + "userId":{ + "shape":"String", + "documentation":"

The identifier of the user id associated with the user aliases.

" + } + }, + "documentation":"

Aliases attached to a user id within an Amazon Q application.

" + }, + "UserAliases":{ + "type":"list", + "member":{"shape":"UserAlias"} + }, + "UserGroups":{ + "type":"list", + "member":{"shape":"String"} + }, + "UserId":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^\\P{C}*$" + }, + "UserIds":{ + "type":"list", + "member":{"shape":"String"} + }, + "UserMessage":{ + "type":"string", + "max":7000, + "min":1 + }, + "UsersAndGroups":{ + "type":"structure", + "members":{ + "userGroups":{ + "shape":"UserGroups", + "documentation":"

The user groups associated with a topic control rule.

" + }, + "userIds":{ + "shape":"UserIds", + "documentation":"

The user ids associated with a topic control rule.

" + } + }, + "documentation":"

Provides information about users and groups associated with a topic control rule.

" + }, + "ValidationException":{ + "type":"structure", + "required":[ + "message", + "reason" + ], + "members":{ + "fields":{ + "shape":"ValidationExceptionFields", + "documentation":"

The input field(s) that failed validation.

" + }, + "message":{ + "shape":"ErrorMessage", + "documentation":"

The message describing the ValidationException.

" + }, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"

The reason for the ValidationException.

" + } + }, + "documentation":"

The input doesn't meet the constraints set by the Amazon Q service. Provide the correct input and try again.

", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "message", + "name" + ], + "members":{ + "message":{ + "shape":"String", + "documentation":"

A message about the validation exception.

" + }, + "name":{ + "shape":"String", + "documentation":"

The field name where the invalid entry was detected.

" + } + }, + "documentation":"

The input failed to meet the constraints specified by Amazon Q in a specified field.

" + }, + "ValidationExceptionFields":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "CANNOT_PARSE", + "FIELD_VALIDATION_FAILED", + "UNKNOWN_OPERATION" + ] + }, + "WebExperience":{ + "type":"structure", + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" + }, + "defaultEndpoint":{ + "shape":"Url", + "documentation":"

The endpoint URLs for your Amazon Q web experience. The URLs are unique and fully hosted by Amazon Web Services.

" + }, + "status":{ + "shape":"WebExperienceStatus", + "documentation":"

The status of your Amazon Q web experience.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp when your Amazon Q web experience was updated.

" + }, + "webExperienceId":{ + "shape":"WebExperienceId", + "documentation":"

The identifier of your Amazon Q web experience.

" + } + }, + "documentation":"

Provides information for an Amazon Q web experience.

" + }, + "WebExperienceArn":{ + "type":"string", + "max":1284, + "min":0, + "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + }, + "WebExperienceAuthConfiguration":{ + "type":"structure", + "members":{ + "samlConfiguration":{"shape":"SamlConfiguration"} + }, + "documentation":"

Provides the authorization configuration information needed to deploy a Amazon Q web experience to end users.

", + "union":true + }, + "WebExperienceId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "WebExperienceSamplePromptsControlMode":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "WebExperienceStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "PENDING_AUTH_CONFIG" + ] + }, + "WebExperienceSubtitle":{ + "type":"string", + "max":500, + "min":0, + "pattern":"^\\P{C}*$" + }, + "WebExperienceTitle":{ + "type":"string", + "max":500, + "min":0, + "pattern":"^\\P{C}*$" + }, + "WebExperienceWelcomeMessage":{ + "type":"string", + "max":300, + "min":0 + }, + "WebExperiences":{ + "type":"list", + "member":{"shape":"WebExperience"} + } + }, + "documentation":"

" +} diff --git a/botocore/data/qconnect/2020-10-19/endpoint-rule-set-1.json b/botocore/data/qconnect/2020-10-19/endpoint-rule-set-1.json new file mode 100644 index 0000000000..cc28c8c33e --- /dev/null +++ b/botocore/data/qconnect/2020-10-19/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/botocore/data/qconnect/2020-10-19/paginators-1.json b/botocore/data/qconnect/2020-10-19/paginators-1.json new file mode 100644 index 0000000000..2d69a26956 --- /dev/null +++ b/botocore/data/qconnect/2020-10-19/paginators-1.json @@ -0,0 +1,64 @@ +{ + "pagination": { + "ListAssistantAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "assistantAssociationSummaries" + }, + "ListAssistants": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "assistantSummaries" + }, + "ListContents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "contentSummaries" + }, + "ListImportJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "importJobSummaries" + }, + "ListKnowledgeBases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "knowledgeBaseSummaries" + }, + "ListQuickResponses": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "quickResponseSummaries" + }, + "QueryAssistant": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "results" + }, + "SearchContent": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "contentSummaries" + }, + "SearchQuickResponses": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "results" + }, + "SearchSessions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "sessionSummaries" + } + } +} diff --git a/botocore/data/qconnect/2020-10-19/service-2.json b/botocore/data/qconnect/2020-10-19/service-2.json new file mode 100644 index 0000000000..854289640c --- /dev/null +++ b/botocore/data/qconnect/2020-10-19/service-2.json @@ -0,0 +1,4399 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-10-19", + "endpointPrefix":"wisdom", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon Q Connect", + "serviceId":"QConnect", + "signatureVersion":"v4", + "signingName":"wisdom", + "uid":"qconnect-2020-10-19" + }, + "operations":{ + "CreateAssistant":{ + "name":"CreateAssistant", + "http":{ + "method":"POST", + "requestUri":"/assistants", + "responseCode":200 + }, + "input":{"shape":"CreateAssistantRequest"}, + "output":{"shape":"CreateAssistantResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Creates an Amazon Q in Connect assistant.

", + "idempotent":true + }, + "CreateAssistantAssociation":{ + "name":"CreateAssistantAssociation", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/associations", + "responseCode":200 + }, + "input":{"shape":"CreateAssistantAssociationRequest"}, + "output":{"shape":"CreateAssistantAssociationResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

", + "idempotent":true + }, + "CreateContent":{ + "name":"CreateContent", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents", + "responseCode":200 + }, + "input":{"shape":"CreateContentRequest"}, + "output":{"shape":"CreateContentResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates Amazon Q content. Before to calling this API, use StartContentUpload to upload an asset.

", + "idempotent":true + }, + "CreateKnowledgeBase":{ + "name":"CreateKnowledgeBase", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases", + "responseCode":200 + }, + "input":{"shape":"CreateKnowledgeBaseRequest"}, + "output":{"shape":"CreateKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Creates a knowledge base.

When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:

  1. Call DeleteKnowledgeBase.

  2. Call DeleteDataIntegration.

  3. Call CreateDataIntegration to recreate the DataIntegration or a create different one.

  4. Call CreateKnowledgeBase.

", + "idempotent":true + }, + "CreateQuickResponse":{ + "name":"CreateQuickResponse", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/quickResponses", + "responseCode":200 + }, + "input":{"shape":"CreateQuickResponseRequest"}, + "output":{"shape":"CreateQuickResponseResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates a Amazon Q quick response.

", + "idempotent":true + }, + "CreateSession":{ + "name":"CreateSession", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/sessions", + "responseCode":200 + }, + "input":{"shape":"CreateSessionRequest"}, + "output":{"shape":"CreateSessionResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q session for each contact on which Amazon Q is enabled.

", + "idempotent":true + }, + "DeleteAssistant":{ + "name":"DeleteAssistant", + "http":{ + "method":"DELETE", + "requestUri":"/assistants/{assistantId}", + "responseCode":204 + }, + "input":{"shape":"DeleteAssistantRequest"}, + "output":{"shape":"DeleteAssistantResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes an assistant.

", + "idempotent":true + }, + "DeleteAssistantAssociation":{ + "name":"DeleteAssistantAssociation", + "http":{ + "method":"DELETE", + "requestUri":"/assistants/{assistantId}/associations/{assistantAssociationId}", + "responseCode":204 + }, + "input":{"shape":"DeleteAssistantAssociationRequest"}, + "output":{"shape":"DeleteAssistantAssociationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes an assistant association.

", + "idempotent":true + }, + "DeleteContent":{ + "name":"DeleteContent", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "responseCode":204 + }, + "input":{"shape":"DeleteContentRequest"}, + "output":{"shape":"DeleteContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes the content.

", + "idempotent":true + }, + "DeleteImportJob":{ + "name":"DeleteImportJob", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", + "responseCode":204 + }, + "input":{"shape":"DeleteImportJobRequest"}, + "output":{"shape":"DeleteImportJobResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes the quick response import job.

", + "idempotent":true + }, + "DeleteKnowledgeBase":{ + "name":"DeleteKnowledgeBase", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}", + "responseCode":204 + }, + "input":{"shape":"DeleteKnowledgeBaseRequest"}, + "output":{"shape":"DeleteKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes the knowledge base.

When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.

", + "idempotent":true + }, + "DeleteQuickResponse":{ + "name":"DeleteQuickResponse", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", + "responseCode":204 + }, + "input":{"shape":"DeleteQuickResponseRequest"}, + "output":{"shape":"DeleteQuickResponseResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a quick response.

", + "idempotent":true + }, + "GetAssistant":{ + "name":"GetAssistant", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}", + "responseCode":200 + }, + "input":{"shape":"GetAssistantRequest"}, + "output":{"shape":"GetAssistantResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves information about an assistant.

" + }, + "GetAssistantAssociation":{ + "name":"GetAssistantAssociation", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/associations/{assistantAssociationId}", + "responseCode":200 + }, + "input":{"shape":"GetAssistantAssociationRequest"}, + "output":{"shape":"GetAssistantAssociationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves information about an assistant association.

" + }, + "GetContent":{ + "name":"GetContent", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "responseCode":200 + }, + "input":{"shape":"GetContentRequest"}, + "output":{"shape":"GetContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves content, including a pre-signed URL to download the content.

" + }, + "GetContentSummary":{ + "name":"GetContentSummary", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary", + "responseCode":200 + }, + "input":{"shape":"GetContentSummaryRequest"}, + "output":{"shape":"GetContentSummaryResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves summary information about the content.

" + }, + "GetImportJob":{ + "name":"GetImportJob", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", + "responseCode":200 + }, + "input":{"shape":"GetImportJobRequest"}, + "output":{"shape":"GetImportJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves the started import job.

" + }, + "GetKnowledgeBase":{ + "name":"GetKnowledgeBase", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}", + "responseCode":200 + }, + "input":{"shape":"GetKnowledgeBaseRequest"}, + "output":{"shape":"GetKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves information about the knowledge base.

" + }, + "GetQuickResponse":{ + "name":"GetQuickResponse", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", + "responseCode":200 + }, + "input":{"shape":"GetQuickResponseRequest"}, + "output":{"shape":"GetQuickResponseResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves the quick response.

" + }, + "GetRecommendations":{ + "name":"GetRecommendations", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/recommendations", + "responseCode":200 + }, + "input":{"shape":"GetRecommendationsRequest"}, + "output":{"shape":"GetRecommendationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

" + }, + "GetSession":{ + "name":"GetSession", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/sessions/{sessionId}", + "responseCode":200 + }, + "input":{"shape":"GetSessionRequest"}, + "output":{"shape":"GetSessionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves information for a specified session.

" + }, + "ListAssistantAssociations":{ + "name":"ListAssistantAssociations", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/associations", + "responseCode":200 + }, + "input":{"shape":"ListAssistantAssociationsRequest"}, + "output":{"shape":"ListAssistantAssociationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists information about assistant associations.

" + }, + "ListAssistants":{ + "name":"ListAssistants", + "http":{ + "method":"GET", + "requestUri":"/assistants", + "responseCode":200 + }, + "input":{"shape":"ListAssistantsRequest"}, + "output":{"shape":"ListAssistantsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists information about assistants.

" + }, + "ListContents":{ + "name":"ListContents", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents", + "responseCode":200 + }, + "input":{"shape":"ListContentsRequest"}, + "output":{"shape":"ListContentsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the content.

" + }, + "ListImportJobs":{ + "name":"ListImportJobs", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs", + "responseCode":200 + }, + "input":{"shape":"ListImportJobsRequest"}, + "output":{"shape":"ListImportJobsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists information about import jobs.

" + }, + "ListKnowledgeBases":{ + "name":"ListKnowledgeBases", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases", + "responseCode":200 + }, + "input":{"shape":"ListKnowledgeBasesRequest"}, + "output":{"shape":"ListKnowledgeBasesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists the knowledge bases.

" + }, + "ListQuickResponses":{ + "name":"ListQuickResponses", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/quickResponses", + "responseCode":200 + }, + "input":{"shape":"ListQuickResponsesRequest"}, + "output":{"shape":"ListQuickResponsesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists information about quick response.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the tags for the specified resource.

" + }, + "NotifyRecommendationsReceived":{ + "name":"NotifyRecommendationsReceived", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/recommendations/notify", + "responseCode":200 + }, + "input":{"shape":"NotifyRecommendationsReceivedRequest"}, + "output":{"shape":"NotifyRecommendationsReceivedResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.

", + "idempotent":true + }, + "QueryAssistant":{ + "name":"QueryAssistant", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/query", + "responseCode":200 + }, + "input":{"shape":"QueryAssistantRequest"}, + "output":{"shape":"QueryAssistantResponse"}, + "errors":[ + {"shape":"RequestTimeoutException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

" + }, + "RemoveKnowledgeBaseTemplateUri":{ + "name":"RemoveKnowledgeBaseTemplateUri", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/templateUri", + "responseCode":204 + }, + "input":{"shape":"RemoveKnowledgeBaseTemplateUriRequest"}, + "output":{"shape":"RemoveKnowledgeBaseTemplateUriResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes a URI template from a knowledge base.

" + }, + "SearchContent":{ + "name":"SearchContent", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/search", + "responseCode":200 + }, + "input":{"shape":"SearchContentRequest"}, + "output":{"shape":"SearchContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

" + }, + "SearchQuickResponses":{ + "name":"SearchQuickResponses", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/search/quickResponses", + "responseCode":200 + }, + "input":{"shape":"SearchQuickResponsesRequest"}, + "output":{"shape":"SearchQuickResponsesResponse"}, + "errors":[ + {"shape":"RequestTimeoutException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Searches existing Amazon Q quick responses in a Amazon Q knowledge base.

" + }, + "SearchSessions":{ + "name":"SearchSessions", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/searchSessions", + "responseCode":200 + }, + "input":{"shape":"SearchSessionsRequest"}, + "output":{"shape":"SearchSessionsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Searches for sessions.

" + }, + "StartContentUpload":{ + "name":"StartContentUpload", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/upload", + "responseCode":200 + }, + "input":{"shape":"StartContentUploadRequest"}, + "output":{"shape":"StartContentUploadResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

" + }, + "StartImportJob":{ + "name":"StartImportJob", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs", + "responseCode":200 + }, + "input":{"shape":"StartImportJobRequest"}, + "output":{"shape":"StartImportJobResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Start an asynchronous job to import Amazon Q resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.

  • For importing Amazon Q quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"TooManyTagsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Adds the specified tags to the specified resource.

", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes the specified tags from the specified resource.

", + "idempotent":true + }, + "UpdateContent":{ + "name":"UpdateContent", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "responseCode":200 + }, + "input":{"shape":"UpdateContentRequest"}, + "output":{"shape":"UpdateContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates information about the content.

" + }, + "UpdateKnowledgeBaseTemplateUri":{ + "name":"UpdateKnowledgeBaseTemplateUri", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/templateUri", + "responseCode":200 + }, + "input":{"shape":"UpdateKnowledgeBaseTemplateUriRequest"}, + "output":{"shape":"UpdateKnowledgeBaseTemplateUriResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Amazon Q using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.

" + }, + "UpdateQuickResponse":{ + "name":"UpdateQuickResponse", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", + "responseCode":200 + }, + "input":{"shape":"UpdateQuickResponseRequest"}, + "output":{"shape":"UpdateQuickResponseResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates an existing Amazon Q quick response.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

You do not have sufficient access to perform this action.

", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AppIntegrationsConfiguration":{ + "type":"structure", + "required":["appIntegrationArn"], + "members":{ + "appIntegrationArn":{ + "shape":"GenericArn", + "documentation":"

The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

  • For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.

  • For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.

  • For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.

  • For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.

  • For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.

    The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.
" + }, + "objectFields":{ + "shape":"ObjectFieldsList", + "documentation":"

The fields from the source that are made available to your agents in Amazon Q. Optional if ObjectConfiguration is included in the provided DataIntegration.

  • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

  • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

  • For Zendesk, you must include at least id, title, updated_at, and draft.

Make sure to include additional fields. These fields are indexed and used to source recommendations.

" + } + }, + "documentation":"

Configuration information for Amazon AppIntegrations to automatically ingest content.

" + }, + "Arn":{ + "type":"string", + "pattern":"^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$" + }, + "AssistantAssociationData":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantAssociationArn", + "assistantAssociationId", + "assistantId", + "associationData", + "associationType" + ], + "members":{ + "assistantArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q assistant.

" + }, + "assistantAssociationArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the assistant association.

" + }, + "assistantAssociationId":{ + "shape":"Uuid", + "documentation":"

The identifier of the assistant association.

" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"

The identifier of the Amazon Q assistant.

" + }, + "associationData":{ + "shape":"AssistantAssociationOutputData", + "documentation":"

A union type that currently has a single argument, the knowledge base ID.

" + }, + "associationType":{ + "shape":"AssociationType", + "documentation":"

The type of association.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + }, + "documentation":"

Information about the assistant association.

" + }, + "AssistantAssociationInputData":{ + "type":"structure", + "members":{ + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

" + } + }, + "documentation":"

The data that is input into Amazon Q as a result of the assistant association.

", + "union":true + }, + "AssistantAssociationOutputData":{ + "type":"structure", + "members":{ + "knowledgeBaseAssociation":{ + "shape":"KnowledgeBaseAssociationData", + "documentation":"

The knowledge base where output data is sent.

" + } + }, + "documentation":"

The data that is output as a result of the assistant association.

", + "union":true + }, + "AssistantAssociationSummary":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantAssociationArn", + "assistantAssociationId", + "assistantId", + "associationData", + "associationType" + ], + "members":{ + "assistantArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q assistant.

" + }, + "assistantAssociationArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the assistant association.

" + }, + "assistantAssociationId":{ + "shape":"Uuid", + "documentation":"

The identifier of the assistant association.

" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"

The identifier of the Amazon Q assistant.

" + }, + "associationData":{ + "shape":"AssistantAssociationOutputData", + "documentation":"

The association data.

" + }, + "associationType":{ + "shape":"AssociationType", + "documentation":"

The type of association.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + }, + "documentation":"

Summary information about the assistant association.

" + }, + "AssistantAssociationSummaryList":{ + "type":"list", + "member":{"shape":"AssistantAssociationSummary"} + }, + "AssistantCapabilityConfiguration":{ + "type":"structure", + "members":{ + "type":{ + "shape":"AssistantCapabilityType", + "documentation":"

The type of Amazon Q assistant capability.

" + } + }, + "documentation":"

The capability configuration for a Amazon Q assistant.

" + }, + "AssistantCapabilityType":{ + "type":"string", + "enum":[ + "V1", + "V2" + ] + }, + "AssistantData":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantId", + "name", + "status", + "type" + ], + "members":{ + "assistantArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q assistant.

" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"

The identifier of the Amazon Q assistant.

" + }, + "capabilityConfiguration":{ + "shape":"AssistantCapabilityConfiguration", + "documentation":"

The configuration information for the Amazon Q assistant capability.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The description.

" + }, + "integrationConfiguration":{ + "shape":"AssistantIntegrationConfiguration", + "documentation":"

The configuration information for the Amazon Q assistant integration.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name.

" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

" + }, + "status":{ + "shape":"AssistantStatus", + "documentation":"

The status of the assistant.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + }, + "type":{ + "shape":"AssistantType", + "documentation":"

The type of assistant.

" + } + }, + "documentation":"

The assistant data.

" + }, + "AssistantIntegrationConfiguration":{ + "type":"structure", + "members":{ + "topicIntegrationArn":{ + "shape":"GenericArn", + "documentation":"

The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

" + } + }, + "documentation":"

The configuration information for the Amazon Q assistant integration.

" + }, + "AssistantList":{ + "type":"list", + "member":{"shape":"AssistantSummary"} + }, + "AssistantStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED" + ] + }, + "AssistantSummary":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantId", + "name", + "status", + "type" + ], + "members":{ + "assistantArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q assistant.

" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"

The identifier of the Amazon Q assistant.

" + }, + "capabilityConfiguration":{ + "shape":"AssistantCapabilityConfiguration", + "documentation":"

The configuration information for the Amazon Q assistant capability.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The description of the assistant.

" + }, + "integrationConfiguration":{ + "shape":"AssistantIntegrationConfiguration", + "documentation":"

The configuration information for the Amazon Q assistant integration.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the assistant.

" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

" + }, + "status":{ + "shape":"AssistantStatus", + "documentation":"

The status of the assistant.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + }, + "type":{ + "shape":"AssistantType", + "documentation":"

The type of the assistant.

" + } + }, + "documentation":"

Summary information about the assistant.

" + }, + "AssistantType":{ + "type":"string", + "enum":["AGENT"] + }, + "AssociationType":{ + "type":"string", + "enum":["KNOWLEDGE_BASE"] + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "Channel":{ + "type":"string", + "max":10, + "min":1, + "sensitive":true + }, + "Channels":{ + "type":"list", + "member":{"shape":"Channel"} + }, + "ClientToken":{ + "type":"string", + "max":4096, + "min":1 + }, + "Configuration":{ + "type":"structure", + "members":{ + "connectConfiguration":{ + "shape":"ConnectConfiguration", + "documentation":"

The configuration information of the Amazon Connect data source.

" + } + }, + "documentation":"

The configuration information of the external data source.

", + "union":true + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ConnectConfiguration":{ + "type":"structure", + "members":{ + "instanceId":{ + "shape":"NonEmptyString", + "documentation":"

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" + } + }, + "documentation":"

The configuration information of the Amazon Connect data source.

" + }, + "ContactAttributeKey":{"type":"string"}, + "ContactAttributeKeys":{ + "type":"list", + "member":{"shape":"ContactAttributeKey"}, + "sensitive":true + }, + "ContactAttributeValue":{"type":"string"}, + "ContactAttributes":{ + "type":"map", + "key":{"shape":"ContactAttributeKey"}, + "value":{"shape":"ContactAttributeValue"}, + "sensitive":true + }, + "ContentData":{ + "type":"structure", + "required":[ + "contentArn", + "contentId", + "contentType", + "knowledgeBaseArn", + "knowledgeBaseId", + "metadata", + "name", + "revisionId", + "status", + "title", + "url", + "urlExpiry" + ], + "members":{ + "contentArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the content.

" + }, + "contentId":{ + "shape":"Uuid", + "documentation":"

The identifier of the content.

" + }, + "contentType":{ + "shape":"ContentType", + "documentation":"

The media type of the content.

" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the knowledge base.

" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

" + }, + "linkOutUri":{ + "shape":"Uri", + "documentation":"

The URI of the content.

" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the content.

" + }, + "revisionId":{ + "shape":"NonEmptyString", + "documentation":"

The identifier of the content revision.

" + }, + "status":{ + "shape":"ContentStatus", + "documentation":"

The status of the content.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + }, + "title":{ + "shape":"ContentTitle", + "documentation":"

The title of the content.

" + }, + "url":{ + "shape":"Url", + "documentation":"

The URL of the content.

" + }, + "urlExpiry":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The expiration time of the URL as an epoch timestamp.

" + } + }, + "documentation":"

Information about the content.

" + }, + "ContentDataDetails":{ + "type":"structure", + "required":[ + "rankingData", + "textData" + ], + "members":{ + "rankingData":{ + "shape":"RankingData", + "documentation":"

Details about the content ranking data.

" + }, + "textData":{ + "shape":"TextData", + "documentation":"

Details about the content text data.

" + } + }, + "documentation":"

Details about the content data.

" + }, + "ContentMetadata":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"NonEmptyString"}, + "max":10, + "min":0 + }, + "ContentReference":{ + "type":"structure", + "members":{ + "contentArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the content.

" + }, + "contentId":{ + "shape":"Uuid", + "documentation":"

The identifier of the content.

" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the knowledge base.

" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

" + } + }, + "documentation":"

Reference information about the content.

" + }, + "ContentStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED", + "UPDATE_FAILED" + ] + }, + "ContentSummary":{ + "type":"structure", + "required":[ + "contentArn", + "contentId", + "contentType", + "knowledgeBaseArn", + "knowledgeBaseId", + "metadata", + "name", + "revisionId", + "status", + "title" + ], + "members":{ + "contentArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the content.

" + }, + "contentId":{ + "shape":"Uuid", + "documentation":"

The identifier of the content.

" + }, + "contentType":{ + "shape":"ContentType", + "documentation":"

The media type of the content.

" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the knowledge base.

" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the content.

" + }, + "revisionId":{ + "shape":"NonEmptyString", + "documentation":"

The identifier of the revision of the content.

" + }, + "status":{ + "shape":"ContentStatus", + "documentation":"

The status of the content.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + }, + "title":{ + "shape":"ContentTitle", + "documentation":"

The title of the content.

" + } + }, + "documentation":"

Summary information about the content.

" + }, + "ContentSummaryList":{ + "type":"list", + "member":{"shape":"ContentSummary"} + }, + "ContentTitle":{ + "type":"string", + "max":255, + "min":1 + }, + "ContentType":{ + "type":"string", + "pattern":"^(text/(plain|html|csv))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" + }, + "CreateAssistantAssociationRequest":{ + "type":"structure", + "required":[ + "assistantId", + "association", + "associationType" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + }, + "association":{ + "shape":"AssistantAssociationInputData", + "documentation":"

The identifier of the associated resource.

" + }, + "associationType":{ + "shape":"AssociationType", + "documentation":"

The type of association.

" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

", + "idempotencyToken":true + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "CreateAssistantAssociationResponse":{ + "type":"structure", + "members":{ + "assistantAssociation":{ + "shape":"AssistantAssociationData", + "documentation":"

The assistant association.

" + } + } + }, + "CreateAssistantRequest":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

", + "idempotencyToken":true + }, + "description":{ + "shape":"Description", + "documentation":"

The description of the assistant.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the assistant.

" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"

The configuration information for the customer managed key used for encryption.

The customer managed key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + }, + "type":{ + "shape":"AssistantType", + "documentation":"

The type of assistant.

" + } + } + }, + "CreateAssistantResponse":{ + "type":"structure", + "members":{ + "assistant":{ + "shape":"AssistantData", + "documentation":"

Information about the assistant.

" + } + } + }, + "CreateContentRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "name", + "uploadId" + ], + "members":{ + "clientToken":{ + "shape":"NonEmptyString", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

", + "idempotencyToken":true + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.

" + }, + "overrideLinkOutUri":{ + "shape":"Uri", + "documentation":"

The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + }, + "title":{ + "shape":"ContentTitle", + "documentation":"

The title of the content. If not set, the title is equal to the name.

" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"

A pointer to the uploaded asset. This value is returned by StartContentUpload.

" + } + } + }, + "CreateContentResponse":{ + "type":"structure", + "members":{ + "content":{ + "shape":"ContentData", + "documentation":"

The content.

" + } + } + }, + "CreateKnowledgeBaseRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseType", + "name" + ], + "members":{ + "clientToken":{ + "shape":"NonEmptyString", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

", + "idempotencyToken":true + }, + "description":{ + "shape":"Description", + "documentation":"

The description.

" + }, + "knowledgeBaseType":{ + "shape":"KnowledgeBaseType", + "documentation":"

The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the knowledge base.

" + }, + "renderingConfiguration":{ + "shape":"RenderingConfiguration", + "documentation":"

Information about how to render the content.

" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q.

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

" + }, + "sourceConfiguration":{ + "shape":"SourceConfiguration", + "documentation":"

The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "CreateKnowledgeBaseResponse":{ + "type":"structure", + "members":{ + "knowledgeBase":{ + "shape":"KnowledgeBaseData", + "documentation":"

The knowledge base.

" + } + } + }, + "CreateQuickResponseRequest":{ + "type":"structure", + "required":[ + "content", + "knowledgeBaseId", + "name" + ], + "members":{ + "channels":{ + "shape":"Channels", + "documentation":"

The Amazon Connect channels this quick response applies to.

" + }, + "clientToken":{ + "shape":"NonEmptyString", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

", + "idempotencyToken":true + }, + "content":{ + "shape":"QuickResponseDataProvider", + "documentation":"

The content of the quick response.

" + }, + "contentType":{ + "shape":"QuickResponseType", + "documentation":"

The media type of the quick response content.

  • Use application/x.quickresponse;format=plain for a quick response written in plain text.

  • Use application/x.quickresponse;format=markdown for a quick response written in richtext.

" + }, + "description":{ + "shape":"QuickResponseDescription", + "documentation":"

The description of the quick response.

" + }, + "groupingConfiguration":{ + "shape":"GroupingConfiguration", + "documentation":"

The configuration information of the user groups that the quick response is accessible to.

" + }, + "isActive":{ + "shape":"Boolean", + "documentation":"

Whether the quick response is active.

" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"

The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

" + }, + "name":{ + "shape":"QuickResponseName", + "documentation":"

The name of the quick response.

" + }, + "shortcutKey":{ + "shape":"ShortCutKey", + "documentation":"

The shortcut key of the quick response. The value should be unique across the knowledge base.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "CreateQuickResponseResponse":{ + "type":"structure", + "members":{ + "quickResponse":{ + "shape":"QuickResponseData", + "documentation":"

The quick response.

" + } + } + }, + "CreateSessionRequest":{ + "type":"structure", + "required":[ + "assistantId", + "name" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

", + "idempotencyToken":true + }, + "description":{ + "shape":"Description", + "documentation":"

The description.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the session.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "CreateSessionResponse":{ + "type":"structure", + "members":{ + "session":{ + "shape":"SessionData", + "documentation":"

The session.

" + } + } + }, + "DataDetails":{ + "type":"structure", + "members":{ + "contentData":{ + "shape":"ContentDataDetails", + "documentation":"

Details about the content data.

" + }, + "generativeData":{ + "shape":"GenerativeDataDetails", + "documentation":"

Details about the generative data.

" + }, + "sourceContentData":{ + "shape":"SourceContentDataDetails", + "documentation":"

Details about the content data.

" + } + }, + "documentation":"

Details about the data.

", + "union":true + }, + "DataReference":{ + "type":"structure", + "members":{ + "contentReference":{"shape":"ContentReference"}, + "generativeReference":{ + "shape":"GenerativeReference", + "documentation":"

Reference information about the generative content.

" + } + }, + "documentation":"

Reference data.

", + "union":true + }, + "DataSummary":{ + "type":"structure", + "required":[ + "details", + "reference" + ], + "members":{ + "details":{ + "shape":"DataDetails", + "documentation":"

Details about the data.

" + }, + "reference":{ + "shape":"DataReference", + "documentation":"

Reference information about the content.

" + } + }, + "documentation":"

Summary of the data.

" + }, + "DataSummaryList":{ + "type":"list", + "member":{"shape":"DataSummary"} + }, + "DeleteAssistantAssociationRequest":{ + "type":"structure", + "required":[ + "assistantAssociationId", + "assistantId" + ], + "members":{ + "assistantAssociationId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantAssociationId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "DeleteAssistantAssociationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAssistantRequest":{ + "type":"structure", + "required":["assistantId"], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "DeleteAssistantResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteContentRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DeleteContentResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteImportJobRequest":{ + "type":"structure", + "required":[ + "importJobId", + "knowledgeBaseId" + ], + "members":{ + "importJobId":{ + "shape":"Uuid", + "documentation":"

The identifier of the import job to be deleted.

", + "location":"uri", + "locationName":"importJobId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DeleteImportJobResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteKnowledgeBaseRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DeleteKnowledgeBaseResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteQuickResponseRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "quickResponseId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "quickResponseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the quick response to delete.

", + "location":"uri", + "locationName":"quickResponseId" + } + } + }, + "DeleteQuickResponseResponse":{ + "type":"structure", + "members":{ + } + }, + "Description":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\s_.,-]+" + }, + "Document":{ + "type":"structure", + "required":["contentReference"], + "members":{ + "contentReference":{ + "shape":"ContentReference", + "documentation":"

A reference to the content resource.

" + }, + "excerpt":{ + "shape":"DocumentText", + "documentation":"

The excerpt from the document.

" + }, + "title":{ + "shape":"DocumentText", + "documentation":"

The title of the document.

" + } + }, + "documentation":"

The document.

" + }, + "DocumentText":{ + "type":"structure", + "members":{ + "highlights":{ + "shape":"Highlights", + "documentation":"

Highlights in the document text.

" + }, + "text":{ + "shape":"SensitiveString", + "documentation":"

Text in the document.

" + } + }, + "documentation":"

The text of the document.

" + }, + "ExternalSource":{ + "type":"string", + "enum":["AMAZON_CONNECT"] + }, + "ExternalSourceConfiguration":{ + "type":"structure", + "required":[ + "configuration", + "source" + ], + "members":{ + "configuration":{ + "shape":"Configuration", + "documentation":"

The configuration information of the external data source.

" + }, + "source":{ + "shape":"ExternalSource", + "documentation":"

The type of the external data source.

" + } + }, + "documentation":"

The configuration information of the external data source.

" + }, + "Filter":{ + "type":"structure", + "required":[ + "field", + "operator", + "value" + ], + "members":{ + "field":{ + "shape":"FilterField", + "documentation":"

The field on which to filter.

" + }, + "operator":{ + "shape":"FilterOperator", + "documentation":"

The operator to use for comparing the field’s value with the provided value.

" + }, + "value":{ + "shape":"NonEmptyString", + "documentation":"

The desired field value on which to filter.

" + } + }, + "documentation":"

A search filter.

" + }, + "FilterField":{ + "type":"string", + "enum":["NAME"] + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "FilterOperator":{ + "type":"string", + "enum":["EQUALS"] + }, + "GenerativeDataDetails":{ + "type":"structure", + "required":[ + "completion", + "rankingData", + "references" + ], + "members":{ + "completion":{ + "shape":"SensitiveString", + "documentation":"

The LLM response.

" + }, + "rankingData":{ + "shape":"RankingData", + "documentation":"

Details about the generative content ranking data.

" + }, + "references":{ + "shape":"DataSummaryList", + "documentation":"

The references used to generative the LLM response.

" + } + }, + "documentation":"

Details about generative data.

" + }, + "GenerativeReference":{ + "type":"structure", + "members":{ + "generationId":{ + "shape":"Uuid", + "documentation":"

The identifier of the LLM model.

" + }, + "modelId":{ + "shape":"LlmModelId", + "documentation":"

The identifier of the LLM model.

" + } + }, + "documentation":"

Reference information about generative content.

" + }, + "GenericArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$" + }, + "GetAssistantAssociationRequest":{ + "type":"structure", + "required":[ + "assistantAssociationId", + "assistantId" + ], + "members":{ + "assistantAssociationId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantAssociationId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "GetAssistantAssociationResponse":{ + "type":"structure", + "members":{ + "assistantAssociation":{ + "shape":"AssistantAssociationData", + "documentation":"

The assistant association.

" + } + } + }, + "GetAssistantRequest":{ + "type":"structure", + "required":["assistantId"], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "GetAssistantResponse":{ + "type":"structure", + "members":{ + "assistant":{ + "shape":"AssistantData", + "documentation":"

Information about the assistant.

" + } + } + }, + "GetContentRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetContentResponse":{ + "type":"structure", + "members":{ + "content":{ + "shape":"ContentData", + "documentation":"

The content.

" + } + } + }, + "GetContentSummaryRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetContentSummaryResponse":{ + "type":"structure", + "members":{ + "contentSummary":{ + "shape":"ContentSummary", + "documentation":"

The content summary.

" + } + } + }, + "GetImportJobRequest":{ + "type":"structure", + "required":[ + "importJobId", + "knowledgeBaseId" + ], + "members":{ + "importJobId":{ + "shape":"Uuid", + "documentation":"

The identifier of the import job to retrieve.

", + "location":"uri", + "locationName":"importJobId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base that the import job belongs to.

", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetImportJobResponse":{ + "type":"structure", + "members":{ + "importJob":{ + "shape":"ImportJobData", + "documentation":"

The import job.

" + } + } + }, + "GetKnowledgeBaseRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetKnowledgeBaseResponse":{ + "type":"structure", + "members":{ + "knowledgeBase":{ + "shape":"KnowledgeBaseData", + "documentation":"

The knowledge base.

" + } + } + }, + "GetQuickResponseRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "quickResponseId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "quickResponseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the quick response.

", + "location":"uri", + "locationName":"quickResponseId" + } + } + }, + "GetQuickResponseResponse":{ + "type":"structure", + "members":{ + "quickResponse":{ + "shape":"QuickResponseData", + "documentation":"

The quick response.

" + } + } + }, + "GetRecommendationsRequest":{ + "type":"structure", + "required":[ + "assistantId", + "sessionId" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + }, + "sessionId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"sessionId" + }, + "waitTimeSeconds":{ + "shape":"WaitTimeSeconds", + "documentation":"

The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

", + "location":"querystring", + "locationName":"waitTimeSeconds" + } + } + }, + "GetRecommendationsResponse":{ + "type":"structure", + "required":["recommendations"], + "members":{ + "recommendations":{ + "shape":"RecommendationList", + "documentation":"

The recommendations.

" + }, + "triggers":{ + "shape":"RecommendationTriggerList", + "documentation":"

The triggers corresponding to recommendations.

" + } + } + }, + "GetSessionRequest":{ + "type":"structure", + "required":[ + "assistantId", + "sessionId" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + }, + "sessionId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "GetSessionResponse":{ + "type":"structure", + "members":{ + "session":{ + "shape":"SessionData", + "documentation":"

The session.

" + } + } + }, + "GroupingConfiguration":{ + "type":"structure", + "members":{ + "criteria":{ + "shape":"GroupingCriteria", + "documentation":"

The criteria used for grouping Amazon Q users.

The following is the list of supported criteria values.

" + }, + "values":{ + "shape":"GroupingValues", + "documentation":"

The list of values that define different groups of Amazon Q users.

" + } + }, + "documentation":"

The configuration information of the grouping of Amazon Q users.

" + }, + "GroupingCriteria":{ + "type":"string", + "max":100, + "min":1, + "sensitive":true + }, + "GroupingValue":{ + "type":"string", + "max":2048, + "min":1, + "sensitive":true + }, + "GroupingValues":{ + "type":"list", + "member":{"shape":"GroupingValue"} + }, + "Headers":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"NonEmptyString"} + }, + "Highlight":{ + "type":"structure", + "members":{ + "beginOffsetInclusive":{ + "shape":"HighlightOffset", + "documentation":"

The offset for the start of the highlight.

" + }, + "endOffsetExclusive":{ + "shape":"HighlightOffset", + "documentation":"

The offset for the end of the highlight.

" + } + }, + "documentation":"

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

" + }, + "HighlightOffset":{"type":"integer"}, + "Highlights":{ + "type":"list", + "member":{"shape":"Highlight"} + }, + "ImportJobData":{ + "type":"structure", + "required":[ + "createdTime", + "importJobId", + "importJobType", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedTime", + "status", + "uploadId", + "url", + "urlExpiry" + ], + "members":{ + "createdTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The timestamp when the import job was created.

" + }, + "externalSourceConfiguration":{"shape":"ExternalSourceConfiguration"}, + "failedRecordReport":{ + "shape":"Url", + "documentation":"

The link to donwload the information of resource data that failed to be imported.

" + }, + "importJobId":{ + "shape":"Uuid", + "documentation":"

The identifier of the import job.

" + }, + "importJobType":{ + "shape":"ImportJobType", + "documentation":"

The type of the import job.

" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the knowledge base.

" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The timestamp when the import job data was last modified.

" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"

The metadata fields of the imported Amazon Q resources.

" + }, + "status":{ + "shape":"ImportJobStatus", + "documentation":"

The status of the import job.

" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"

A pointer to the uploaded asset. This value is returned by StartContentUpload.

" + }, + "url":{ + "shape":"Url", + "documentation":"

The download link to the resource file that is uploaded to the import job.

" + }, + "urlExpiry":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The expiration time of the URL as an epoch timestamp.

" + } + }, + "documentation":"

Summary information about the import job.

" + }, + "ImportJobList":{ + "type":"list", + "member":{"shape":"ImportJobSummary"} + }, + "ImportJobStatus":{ + "type":"string", + "enum":[ + "START_IN_PROGRESS", + "FAILED", + "COMPLETE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED" + ] + }, + "ImportJobSummary":{ + "type":"structure", + "required":[ + "createdTime", + "importJobId", + "importJobType", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedTime", + "status", + "uploadId" + ], + "members":{ + "createdTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The timestamp when the import job was created.

" + }, + "externalSourceConfiguration":{ + "shape":"ExternalSourceConfiguration", + "documentation":"

The configuration information of the external source that the resource data are imported from.

" + }, + "importJobId":{ + "shape":"Uuid", + "documentation":"

The identifier of the import job.

" + }, + "importJobType":{ + "shape":"ImportJobType", + "documentation":"

The type of import job.

" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the knowledge base.

" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The timestamp when the import job was last modified.

" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"

The metadata fields of the imported Amazon Q resources.

" + }, + "status":{ + "shape":"ImportJobStatus", + "documentation":"

The status of the import job.

" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"

A pointer to the uploaded asset. This value is returned by StartContentUpload.

" + } + }, + "documentation":"

Summary information about the import job.

" + }, + "ImportJobType":{ + "type":"string", + "enum":["QUICK_RESPONSES"] + }, + "KnowledgeBaseAssociationData":{ + "type":"structure", + "members":{ + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the knowledge base.

" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

" + } + }, + "documentation":"

Association information about the knowledge base.

" + }, + "KnowledgeBaseData":{ + "type":"structure", + "required":[ + "knowledgeBaseArn", + "knowledgeBaseId", + "knowledgeBaseType", + "name", + "status" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"

The description.

" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the knowledge base.

" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

" + }, + "knowledgeBaseType":{ + "shape":"KnowledgeBaseType", + "documentation":"

The type of knowledge base.

" + }, + "lastContentModificationTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the knowledge base.

" + }, + "renderingConfiguration":{ + "shape":"RenderingConfiguration", + "documentation":"

Information about how to render the content.

" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q.

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

" + }, + "sourceConfiguration":{ + "shape":"SourceConfiguration", + "documentation":"

Source configuration information about the knowledge base.

" + }, + "status":{ + "shape":"KnowledgeBaseStatus", + "documentation":"

The status of the knowledge base.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + }, + "documentation":"

Information about the knowledge base.

" + }, + "KnowledgeBaseList":{ + "type":"list", + "member":{"shape":"KnowledgeBaseSummary"} + }, + "KnowledgeBaseStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED" + ] + }, + "KnowledgeBaseSummary":{ + "type":"structure", + "required":[ + "knowledgeBaseArn", + "knowledgeBaseId", + "knowledgeBaseType", + "name", + "status" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"

The description of the knowledge base.

" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the knowledge base.

" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

" + }, + "knowledgeBaseType":{ + "shape":"KnowledgeBaseType", + "documentation":"

The type of knowledge base.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the knowledge base.

" + }, + "renderingConfiguration":{ + "shape":"RenderingConfiguration", + "documentation":"

Information about how to render the content.

" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q.

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

" + }, + "sourceConfiguration":{ + "shape":"SourceConfiguration", + "documentation":"

Configuration information about the external data source.

" + }, + "status":{ + "shape":"KnowledgeBaseStatus", + "documentation":"

The status of the knowledge base summary.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + }, + "documentation":"

Summary information about the knowledge base.

" + }, + "KnowledgeBaseType":{ + "type":"string", + "enum":[ + "EXTERNAL", + "CUSTOM", + "QUICK_RESPONSES" + ] + }, + "LanguageCode":{ + "type":"string", + "max":5, + "min":2 + }, + "ListAssistantAssociationsRequest":{ + "type":"structure", + "required":["assistantId"], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListAssistantAssociationsResponse":{ + "type":"structure", + "required":["assistantAssociationSummaries"], + "members":{ + "assistantAssociationSummaries":{ + "shape":"AssistantAssociationSummaryList", + "documentation":"

Summary information about assistant associations.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListAssistantsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListAssistantsResponse":{ + "type":"structure", + "required":["assistantSummaries"], + "members":{ + "assistantSummaries":{ + "shape":"AssistantList", + "documentation":"

Information about the assistants.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListContentsRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListContentsResponse":{ + "type":"structure", + "required":["contentSummaries"], + "members":{ + "contentSummaries":{ + "shape":"ContentSummaryList", + "documentation":"

Information about the content.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListImportJobsRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListImportJobsResponse":{ + "type":"structure", + "required":["importJobSummaries"], + "members":{ + "importJobSummaries":{ + "shape":"ImportJobList", + "documentation":"

Summary information about the import jobs.

" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

" + } + } + }, + "ListKnowledgeBasesRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListKnowledgeBasesResponse":{ + "type":"structure", + "required":["knowledgeBaseSummaries"], + "members":{ + "knowledgeBaseSummaries":{ + "shape":"KnowledgeBaseList", + "documentation":"

Information about the knowledge bases.

" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListQuickResponsesRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListQuickResponsesResponse":{ + "type":"structure", + "required":["quickResponseSummaries"], + "members":{ + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

" + }, + "quickResponseSummaries":{ + "shape":"QuickResponseSummaryList", + "documentation":"

Summary information about the quick responses.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "LlmModelId":{ + "type":"string", + "max":128, + "min":1 + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "Name":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\s_.,-]+" + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1 + }, + "NonEmptyString":{ + "type":"string", + "max":4096, + "min":1 + }, + "NotifyRecommendationsReceivedError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"NotifyRecommendationsReceivedErrorMessage", + "documentation":"

A recommendation is causing an error.

" + }, + "recommendationId":{ + "shape":"RecommendationId", + "documentation":"

The identifier of the recommendation that is in error.

" + } + }, + "documentation":"

An error occurred when creating a recommendation.

" + }, + "NotifyRecommendationsReceivedErrorList":{ + "type":"list", + "member":{"shape":"NotifyRecommendationsReceivedError"} + }, + "NotifyRecommendationsReceivedErrorMessage":{"type":"string"}, + "NotifyRecommendationsReceivedRequest":{ + "type":"structure", + "required":[ + "assistantId", + "recommendationIds", + "sessionId" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + }, + "recommendationIds":{ + "shape":"RecommendationIdList", + "documentation":"

The identifiers of the recommendations.

" + }, + "sessionId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "NotifyRecommendationsReceivedResponse":{ + "type":"structure", + "members":{ + "errors":{ + "shape":"NotifyRecommendationsReceivedErrorList", + "documentation":"

The identifiers of recommendations that are causing errors.

" + }, + "recommendationIds":{ + "shape":"RecommendationIdList", + "documentation":"

The identifiers of the recommendations.

" + } + } + }, + "ObjectFieldsList":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":100, + "min":1 + }, + "Order":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "PreconditionFailedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The provided revisionId does not match, indicating the content has been modified since it was last read.

", + "error":{ + "httpStatusCode":412, + "senderFault":true + }, + "exception":true + }, + "Priority":{ + "type":"string", + "enum":[ + "HIGH", + "MEDIUM", + "LOW" + ] + }, + "QueryAssistantRequest":{ + "type":"structure", + "required":[ + "assistantId", + "queryText" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per page.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

" + }, + "queryCondition":{ + "shape":"QueryConditionExpression", + "documentation":"

Information about how to query content.

" + }, + "queryText":{ + "shape":"QueryText", + "documentation":"

The text to search for.

" + }, + "sessionId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.

" + } + } + }, + "QueryAssistantResponse":{ + "type":"structure", + "required":["results"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + }, + "results":{ + "shape":"QueryResultsList", + "documentation":"

The results of the query.

" + } + } + }, + "QueryCondition":{ + "type":"structure", + "members":{ + "single":{ + "shape":"QueryConditionItem", + "documentation":"

The condition for the query.

" + } + }, + "documentation":"

Information about how to query content.

", + "union":true + }, + "QueryConditionComparisonOperator":{ + "type":"string", + "enum":["EQUALS"] + }, + "QueryConditionExpression":{ + "type":"list", + "member":{"shape":"QueryCondition"}, + "max":1, + "min":0 + }, + "QueryConditionFieldName":{ + "type":"string", + "enum":["RESULT_TYPE"] + }, + "QueryConditionItem":{ + "type":"structure", + "required":[ + "comparator", + "field", + "value" + ], + "members":{ + "comparator":{ + "shape":"QueryConditionComparisonOperator", + "documentation":"

The comparison operator for query condition to query on.

" + }, + "field":{ + "shape":"QueryConditionFieldName", + "documentation":"

The name of the field for query condition to query on.

" + }, + "value":{ + "shape":"NonEmptyString", + "documentation":"

The value for the query condition to query on.

" + } + }, + "documentation":"

The condition for the query.

" + }, + "QueryRecommendationTriggerData":{ + "type":"structure", + "members":{ + "text":{ + "shape":"QueryText", + "documentation":"

The text associated with the recommendation trigger.

" + } + }, + "documentation":"

Data associated with the QUERY RecommendationTriggerType.

" + }, + "QueryResultType":{ + "type":"string", + "enum":[ + "KNOWLEDGE_CONTENT", + "GENERATIVE_ANSWER" + ] + }, + "QueryResultsList":{ + "type":"list", + "member":{"shape":"ResultData"} + }, + "QueryText":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "QuickResponseContent":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "QuickResponseContentProvider":{ + "type":"structure", + "members":{ + "content":{ + "shape":"QuickResponseContent", + "documentation":"

The content of the quick response.

" + } + }, + "documentation":"

The container quick response content.

", + "union":true + }, + "QuickResponseContents":{ + "type":"structure", + "members":{ + "markdown":{"shape":"QuickResponseContentProvider"}, + "plainText":{"shape":"QuickResponseContentProvider"} + }, + "documentation":"

The content of the quick response stored in different media types.

" + }, + "QuickResponseData":{ + "type":"structure", + "required":[ + "contentType", + "createdTime", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedTime", + "name", + "quickResponseArn", + "quickResponseId", + "status" + ], + "members":{ + "channels":{ + "shape":"Channels", + "documentation":"

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

" + }, + "contentType":{ + "shape":"QuickResponseType", + "documentation":"

The media type of the quick response content.

  • Use application/x.quickresponse;format=plain for quick response written in plain text.

  • Use application/x.quickresponse;format=markdown for quick response written in richtext.

" + }, + "contents":{ + "shape":"QuickResponseContents", + "documentation":"

The contents of the quick response.

" + }, + "createdTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The timestamp when the quick response was created.

" + }, + "description":{ + "shape":"QuickResponseDescription", + "documentation":"

The description of the quick response.

" + }, + "groupingConfiguration":{ + "shape":"GroupingConfiguration", + "documentation":"

The configuration information of the user groups that the quick response is accessible to.

" + }, + "isActive":{ + "shape":"Boolean", + "documentation":"

Whether the quick response is active.

" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the knowledge base.

" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"

The language code value for the language in which the quick response is written.

" + }, + "lastModifiedBy":{ + "shape":"GenericArn", + "documentation":"

The Amazon Resource Name (ARN) of the user who last updated the quick response data.

" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The timestamp when the quick response data was last modified.

" + }, + "name":{ + "shape":"QuickResponseName", + "documentation":"

The name of the quick response.

" + }, + "quickResponseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the quick response.

" + }, + "quickResponseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the quick response.

" + }, + "shortcutKey":{ + "shape":"ShortCutKey", + "documentation":"

The shortcut key of the quick response. The value should be unique across the knowledge base.

" + }, + "status":{ + "shape":"QuickResponseStatus", + "documentation":"

The status of the quick response data.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + }, + "documentation":"

Information about the quick response.

" + }, + "QuickResponseDataProvider":{ + "type":"structure", + "members":{ + "content":{ + "shape":"QuickResponseContent", + "documentation":"

The content of the quick response.

" + } + }, + "documentation":"

The container of quick response data.

", + "union":true + }, + "QuickResponseDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "QuickResponseFilterField":{ + "type":"structure", + "required":[ + "name", + "operator" + ], + "members":{ + "includeNoExistence":{ + "shape":"Boolean", + "documentation":"

Whether to treat null value as a match for the attribute field.

" + }, + "name":{ + "shape":"NonEmptyString", + "documentation":"

The name of the attribute field to filter the quick responses by.

" + }, + "operator":{ + "shape":"QuickResponseFilterOperator", + "documentation":"

The operator to use for filtering.

" + }, + "values":{ + "shape":"QuickResponseFilterValueList", + "documentation":"

The values of attribute field to filter the quick response by.

" + } + }, + "documentation":"

The quick response fields to filter the quick response query results by.

The following is the list of supported field names.

  • name

  • description

  • shortcutKey

  • isActive

  • channels

  • language

  • contentType

  • createdTime

  • lastModifiedTime

  • lastModifiedBy

  • groupingConfiguration.criteria

  • groupingConfiguration.values

" + }, + "QuickResponseFilterFieldList":{ + "type":"list", + "member":{"shape":"QuickResponseFilterField"}, + "max":10, + "min":0 + }, + "QuickResponseFilterOperator":{ + "type":"string", + "enum":[ + "EQUALS", + "PREFIX" + ] + }, + "QuickResponseFilterValue":{ + "type":"string", + "max":2048, + "min":1 + }, + "QuickResponseFilterValueList":{ + "type":"list", + "member":{"shape":"QuickResponseFilterValue"}, + "max":5, + "min":1 + }, + "QuickResponseName":{ + "type":"string", + "max":40, + "min":1 + }, + "QuickResponseOrderField":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"NonEmptyString", + "documentation":"

The name of the attribute to order the quick response query results by.

" + }, + "order":{ + "shape":"Order", + "documentation":"

The order at which the quick responses are sorted by.

" + } + }, + "documentation":"

The quick response fields to order the quick response query results by.

The following is the list of supported field names.

  • name

  • description

  • shortcutKey

  • isActive

  • channels

  • language

  • contentType

  • createdTime

  • lastModifiedTime

  • lastModifiedBy

  • groupingConfiguration.criteria

  • groupingConfiguration.values

" + }, + "QuickResponseQueryField":{ + "type":"structure", + "required":[ + "name", + "operator", + "values" + ], + "members":{ + "allowFuzziness":{ + "shape":"Boolean", + "documentation":"

Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.

" + }, + "name":{ + "shape":"NonEmptyString", + "documentation":"

The name of the attribute to query the quick responses by.

" + }, + "operator":{ + "shape":"QuickResponseQueryOperator", + "documentation":"

The operator to use for matching attribute field values in the query.

" + }, + "priority":{ + "shape":"Priority", + "documentation":"

The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.

" + }, + "values":{ + "shape":"QuickResponseQueryValueList", + "documentation":"

The values of the attribute to query the quick responses by.

" + } + }, + "documentation":"

The quick response fields to query quick responses by.

The following is the list of supported field names.

  • content

  • name

  • description

  • shortcutKey

" + }, + "QuickResponseQueryFieldList":{ + "type":"list", + "member":{"shape":"QuickResponseQueryField"}, + "max":4, + "min":0 + }, + "QuickResponseQueryOperator":{ + "type":"string", + "enum":[ + "CONTAINS", + "CONTAINS_AND_PREFIX" + ] + }, + "QuickResponseQueryValue":{ + "type":"string", + "max":1024, + "min":1 + }, + "QuickResponseQueryValueList":{ + "type":"list", + "member":{"shape":"QuickResponseQueryValue"}, + "max":5, + "min":1 + }, + "QuickResponseSearchExpression":{ + "type":"structure", + "members":{ + "filters":{ + "shape":"QuickResponseFilterFieldList", + "documentation":"

The configuration of filtering rules applied to quick response query results.

" + }, + "orderOnField":{ + "shape":"QuickResponseOrderField", + "documentation":"

The quick response attribute fields on which the query results are ordered.

" + }, + "queries":{ + "shape":"QuickResponseQueryFieldList", + "documentation":"

The quick response query expressions.

" + } + }, + "documentation":"

Information about the import job.

" + }, + "QuickResponseSearchResultData":{ + "type":"structure", + "required":[ + "contentType", + "contents", + "createdTime", + "isActive", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedTime", + "name", + "quickResponseArn", + "quickResponseId", + "status" + ], + "members":{ + "attributesInterpolated":{ + "shape":"ContactAttributeKeys", + "documentation":"

The user defined contact attributes that are resolved when the search result is returned.

" + }, + "attributesNotInterpolated":{ + "shape":"ContactAttributeKeys", + "documentation":"

The user defined contact attributes that are not resolved when the search result is returned.

" + }, + "channels":{ + "shape":"Channels", + "documentation":"

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

" + }, + "contentType":{ + "shape":"QuickResponseType", + "documentation":"

The media type of the quick response content.

  • Use application/x.quickresponse;format=plain for quick response written in plain text.

  • Use application/x.quickresponse;format=markdown for quick response written in richtext.

" + }, + "contents":{ + "shape":"QuickResponseContents", + "documentation":"

The contents of the quick response.

" + }, + "createdTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The timestamp when the quick response was created.

" + }, + "description":{ + "shape":"QuickResponseDescription", + "documentation":"

The description of the quick response.

" + }, + "groupingConfiguration":{ + "shape":"GroupingConfiguration", + "documentation":"

The configuration information of the user groups that the quick response is accessible to.

" + }, + "isActive":{ + "shape":"Boolean", + "documentation":"

Whether the quick response is active.

" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the knowledge base.

" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"

The language code value for the language in which the quick response is written.

" + }, + "lastModifiedBy":{ + "shape":"GenericArn", + "documentation":"

The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.

" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The timestamp when the quick response search result data was last modified.

" + }, + "name":{ + "shape":"QuickResponseName", + "documentation":"

The name of the quick response.

" + }, + "quickResponseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the quick response.

" + }, + "quickResponseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the quick response.

" + }, + "shortcutKey":{ + "shape":"ShortCutKey", + "documentation":"

The shortcut key of the quick response. The value should be unique across the knowledge base.

" + }, + "status":{ + "shape":"QuickResponseStatus", + "documentation":"

The resource status of the quick response.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + }, + "documentation":"

The result of quick response search.

" + }, + "QuickResponseSearchResultsList":{ + "type":"list", + "member":{"shape":"QuickResponseSearchResultData"} + }, + "QuickResponseStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "CREATED", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED", + "UPDATE_IN_PROGRESS", + "UPDATE_FAILED" + ] + }, + "QuickResponseSummary":{ + "type":"structure", + "required":[ + "contentType", + "createdTime", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedTime", + "name", + "quickResponseArn", + "quickResponseId", + "status" + ], + "members":{ + "channels":{ + "shape":"Channels", + "documentation":"

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

" + }, + "contentType":{ + "shape":"QuickResponseType", + "documentation":"

The media type of the quick response content.

  • Use application/x.quickresponse;format=plain for quick response written in plain text.

  • Use application/x.quickresponse;format=markdown for quick response written in richtext.

" + }, + "createdTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The timestamp when the quick response was created.

" + }, + "description":{ + "shape":"QuickResponseDescription", + "documentation":"

The description of the quick response.

" + }, + "isActive":{ + "shape":"Boolean", + "documentation":"

Whether the quick response is active.

" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the knowledge base.

" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

" + }, + "lastModifiedBy":{ + "shape":"GenericArn", + "documentation":"

The Amazon Resource Name (ARN) of the user who last updated the quick response data.

" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The timestamp when the quick response summary was last modified.

" + }, + "name":{ + "shape":"QuickResponseName", + "documentation":"

The name of the quick response.

" + }, + "quickResponseArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the quick response.

" + }, + "quickResponseId":{ + "shape":"Uuid", + "documentation":"

The identifier of the quick response.

" + }, + "status":{ + "shape":"QuickResponseStatus", + "documentation":"

The resource status of the quick response.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + }, + "documentation":"

The summary information about the quick response.

" + }, + "QuickResponseSummaryList":{ + "type":"list", + "member":{"shape":"QuickResponseSummary"} + }, + "QuickResponseType":{ + "type":"string", + "pattern":"^(application/x\\.quickresponse;format=(plain|markdown))$" + }, + "RankingData":{ + "type":"structure", + "members":{ + "relevanceLevel":{ + "shape":"RelevanceLevel", + "documentation":"

The relevance score of the content.

" + }, + "relevanceScore":{ + "shape":"RelevanceScore", + "documentation":"

The relevance level of the recommendation.

" + } + }, + "documentation":"

Details about the source content ranking data.

" + }, + "RecommendationData":{ + "type":"structure", + "required":["recommendationId"], + "members":{ + "data":{ + "shape":"DataSummary", + "documentation":"

Summary of the recommended content.

" + }, + "document":{ + "shape":"Document", + "documentation":"

The recommended document.

" + }, + "recommendationId":{ + "shape":"RecommendationId", + "documentation":"

The identifier of the recommendation.

" + }, + "relevanceLevel":{ + "shape":"RelevanceLevel", + "documentation":"

The relevance level of the recommendation.

" + }, + "relevanceScore":{ + "shape":"RelevanceScore", + "documentation":"

The relevance score of the recommendation.

" + }, + "type":{ + "shape":"RecommendationType", + "documentation":"

The type of recommendation.

" + } + }, + "documentation":"

Information about the recommendation.

" + }, + "RecommendationId":{ + "type":"string", + "max":2048, + "min":1 + }, + "RecommendationIdList":{ + "type":"list", + "member":{"shape":"RecommendationId"}, + "max":25, + "min":0 + }, + "RecommendationList":{ + "type":"list", + "member":{"shape":"RecommendationData"} + }, + "RecommendationSourceType":{ + "type":"string", + "enum":[ + "ISSUE_DETECTION", + "RULE_EVALUATION", + "OTHER" + ] + }, + "RecommendationTrigger":{ + "type":"structure", + "required":[ + "data", + "id", + "recommendationIds", + "source", + "type" + ], + "members":{ + "data":{ + "shape":"RecommendationTriggerData", + "documentation":"

A union type containing information related to the trigger.

" + }, + "id":{ + "shape":"Uuid", + "documentation":"

The identifier of the recommendation trigger.

" + }, + "recommendationIds":{ + "shape":"RecommendationIdList", + "documentation":"

The identifiers of the recommendations.

" + }, + "source":{ + "shape":"RecommendationSourceType", + "documentation":"

The source of the recommendation trigger.

  • ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.

  • RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.

" + }, + "type":{ + "shape":"RecommendationTriggerType", + "documentation":"

The type of recommendation trigger.

" + } + }, + "documentation":"

A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.

" + }, + "RecommendationTriggerData":{ + "type":"structure", + "members":{ + "query":{ + "shape":"QueryRecommendationTriggerData", + "documentation":"

Data associated with the QUERY RecommendationTriggerType.

" + } + }, + "documentation":"

A union type containing information related to the trigger.

", + "union":true + }, + "RecommendationTriggerList":{ + "type":"list", + "member":{"shape":"RecommendationTrigger"} + }, + "RecommendationTriggerType":{ + "type":"string", + "enum":[ + "QUERY", + "GENERATIVE" + ] + }, + "RecommendationType":{ + "type":"string", + "enum":[ + "KNOWLEDGE_CONTENT", + "GENERATIVE_RESPONSE", + "GENERATIVE_ANSWER" + ] + }, + "RelevanceLevel":{ + "type":"string", + "enum":[ + "HIGH", + "MEDIUM", + "LOW" + ] + }, + "RelevanceScore":{ + "type":"double", + "min":0.0 + }, + "RemoveKnowledgeBaseTemplateUriRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "RemoveKnowledgeBaseTemplateUriResponse":{ + "type":"structure", + "members":{ + } + }, + "RenderingConfiguration":{ + "type":"structure", + "members":{ + "templateUri":{ + "shape":"Uri", + "documentation":"

A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

  • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

  • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

  • Zendesk: id, title, updated_at, or draft

The variable is replaced with the actual value for a piece of content when calling GetContent.

" + } + }, + "documentation":"

Information about how to render the content.

" + }, + "RequestTimeoutException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

", + "error":{ + "httpStatusCode":408, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceName":{ + "shape":"String", + "documentation":"

The specified resource name.

" + } + }, + "documentation":"

The specified resource does not exist.

", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResultData":{ + "type":"structure", + "required":["resultId"], + "members":{ + "data":{ + "shape":"DataSummary", + "documentation":"

Summary of the recommended content.

" + }, + "document":{ + "shape":"Document", + "documentation":"

The document.

" + }, + "relevanceScore":{ + "shape":"RelevanceScore", + "documentation":"

The relevance score of the results.

" + }, + "resultId":{ + "shape":"Uuid", + "documentation":"

The identifier of the result data.

" + }, + "type":{ + "shape":"QueryResultType", + "documentation":"

The type of the query result.

" + } + }, + "documentation":"

Information about the result.

" + }, + "SearchContentRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "searchExpression" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "searchExpression":{ + "shape":"SearchExpression", + "documentation":"

The search expression to filter results.

" + } + } + }, + "SearchContentResponse":{ + "type":"structure", + "required":["contentSummaries"], + "members":{ + "contentSummaries":{ + "shape":"ContentSummaryList", + "documentation":"

Summary information about the content.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "SearchExpression":{ + "type":"structure", + "required":["filters"], + "members":{ + "filters":{ + "shape":"FilterList", + "documentation":"

The search expression filters.

" + } + }, + "documentation":"

The search expression.

" + }, + "SearchQuickResponsesRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "searchExpression" + ], + "members":{ + "attributes":{ + "shape":"ContactAttributes", + "documentation":"

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "searchExpression":{ + "shape":"QuickResponseSearchExpression", + "documentation":"

The search expression for querying the quick response.

" + } + } + }, + "SearchQuickResponsesResponse":{ + "type":"structure", + "required":["results"], + "members":{ + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

" + }, + "results":{ + "shape":"QuickResponseSearchResultsList", + "documentation":"

The results of the quick response search.

" + } + } + }, + "SearchSessionsRequest":{ + "type":"structure", + "required":[ + "assistantId", + "searchExpression" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "searchExpression":{ + "shape":"SearchExpression", + "documentation":"

The search expression to filter results.

" + } + } + }, + "SearchSessionsResponse":{ + "type":"structure", + "required":["sessionSummaries"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + }, + "sessionSummaries":{ + "shape":"SessionSummaries", + "documentation":"

Summary information about the sessions.

" + } + } + }, + "SensitiveString":{ + "type":"string", + "sensitive":true + }, + "ServerSideEncryptionConfiguration":{ + "type":"structure", + "members":{ + "kmsKeyId":{ + "shape":"NonEmptyString", + "documentation":"

The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).

" + } + }, + "documentation":"

The configuration information for the customer managed key used for encryption.

" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SessionData":{ + "type":"structure", + "required":[ + "name", + "sessionArn", + "sessionId" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"

The description of the session.

" + }, + "integrationConfiguration":{ + "shape":"SessionIntegrationConfiguration", + "documentation":"

The configuration information for the session integration.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the session.

" + }, + "sessionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the session.

" + }, + "sessionId":{ + "shape":"Uuid", + "documentation":"

The identifier of the session.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + }, + "documentation":"

Information about the session.

" + }, + "SessionIntegrationConfiguration":{ + "type":"structure", + "members":{ + "topicIntegrationArn":{ + "shape":"GenericArn", + "documentation":"

The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

" + } + }, + "documentation":"

The configuration information for the session integration.

" + }, + "SessionSummaries":{ + "type":"list", + "member":{"shape":"SessionSummary"} + }, + "SessionSummary":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantId", + "sessionArn", + "sessionId" + ], + "members":{ + "assistantArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q assistant.

" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"

The identifier of the Amazon Q assistant.

" + }, + "sessionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the session.

" + }, + "sessionId":{ + "shape":"Uuid", + "documentation":"

The identifier of the session.

" + } + }, + "documentation":"

Summary information about the session.

" + }, + "ShortCutKey":{ + "type":"string", + "max":10, + "min":1 + }, + "SourceConfiguration":{ + "type":"structure", + "members":{ + "appIntegrations":{ + "shape":"AppIntegrationsConfiguration", + "documentation":"

Configuration information for Amazon AppIntegrations to automatically ingest content.

" + } + }, + "documentation":"

Configuration information about the external data source.

", + "union":true + }, + "SourceContentDataDetails":{ + "type":"structure", + "required":[ + "id", + "rankingData", + "textData", + "type" + ], + "members":{ + "id":{ + "shape":"Uuid", + "documentation":"

The identifier of the source content.

" + }, + "rankingData":{ + "shape":"RankingData", + "documentation":"

Details about the source content ranking data.

" + }, + "textData":{ + "shape":"TextData", + "documentation":"

Details about the source content text data.

" + }, + "type":{ + "shape":"SourceContentType", + "documentation":"

The type of the source content.

" + } + }, + "documentation":"

Details about the source content data.

" + }, + "SourceContentType":{ + "type":"string", + "enum":["KNOWLEDGE_CONTENT"] + }, + "StartContentUploadRequest":{ + "type":"structure", + "required":[ + "contentType", + "knowledgeBaseId" + ], + "members":{ + "contentType":{ + "shape":"ContentType", + "documentation":"

The type of content to upload.

" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "presignedUrlTimeToLive":{ + "shape":"TimeToLive", + "documentation":"

The expected expiration time of the generated presigned URL, specified in minutes.

" + } + } + }, + "StartContentUploadResponse":{ + "type":"structure", + "required":[ + "headersToInclude", + "uploadId", + "url", + "urlExpiry" + ], + "members":{ + "headersToInclude":{ + "shape":"Headers", + "documentation":"

The headers to include in the upload.

" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"

The identifier of the upload.

" + }, + "url":{ + "shape":"Url", + "documentation":"

The URL of the upload.

" + }, + "urlExpiry":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"

The expiration time of the URL as an epoch timestamp.

" + } + } + }, + "StartImportJobRequest":{ + "type":"structure", + "required":[ + "importJobType", + "knowledgeBaseId", + "uploadId" + ], + "members":{ + "clientToken":{ + "shape":"NonEmptyString", + "documentation":"

The tags used to organize, track, or control access for this resource.

", + "idempotencyToken":true + }, + "externalSourceConfiguration":{ + "shape":"ExternalSourceConfiguration", + "documentation":"

The configuration information of the external source that the resource data are imported from.

" + }, + "importJobType":{ + "shape":"ImportJobType", + "documentation":"

The type of the import job.

  • For importing quick response resource, set the value to QUICK_RESPONSES.

" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • For importing Amazon Q quick responses, this should be a QUICK_RESPONSES type knowledge base.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"

The metadata fields of the imported Amazon Q resources.

" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"

A pointer to the uploaded asset. This value is returned by StartContentUpload.

" + } + } + }, + "StartImportJobResponse":{ + "type":"structure", + "members":{ + "importJob":{ + "shape":"ImportJobData", + "documentation":"

The import job.

" + } + } + }, + "String":{"type":"string"}, + "SyntheticTimestamp_epoch_seconds":{ + "type":"timestamp", + "timestampFormat":"unixTimestamp" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TextData":{ + "type":"structure", + "members":{ + "excerpt":{"shape":"DocumentText"}, + "title":{"shape":"DocumentText"} + }, + "documentation":"

Details about the source content text data.

" + }, + "TimeToLive":{ + "type":"integer", + "documentation":"

Expiration time in minutes

", + "box":true, + "max":60, + "min":1 + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceName":{ + "shape":"String", + "documentation":"

The specified resource name.

" + } + }, + "documentation":"

Amazon Q in Connect throws this exception if you have too many tags in your tag set.

", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

The tag keys.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateContentRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

" + }, + "overrideLinkOutUri":{ + "shape":"Uri", + "documentation":"

The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.

" + }, + "removeOverrideLinkOutUri":{ + "shape":"Boolean", + "documentation":"

Unset the existing overrideLinkOutUri if it exists.

" + }, + "revisionId":{ + "shape":"NonEmptyString", + "documentation":"

The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.

" + }, + "title":{ + "shape":"ContentTitle", + "documentation":"

The title of the content.

" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"

A pointer to the uploaded asset. This value is returned by StartContentUpload.

" + } + } + }, + "UpdateContentResponse":{ + "type":"structure", + "members":{ + "content":{ + "shape":"ContentData", + "documentation":"

The content.

" + } + } + }, + "UpdateKnowledgeBaseTemplateUriRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "templateUri" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "templateUri":{ + "shape":"Uri", + "documentation":"

The template URI to update.

" + } + } + }, + "UpdateKnowledgeBaseTemplateUriResponse":{ + "type":"structure", + "members":{ + "knowledgeBase":{ + "shape":"KnowledgeBaseData", + "documentation":"

The knowledge base to update.

" + } + } + }, + "UpdateQuickResponseRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "quickResponseId" + ], + "members":{ + "channels":{ + "shape":"Channels", + "documentation":"

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

" + }, + "content":{ + "shape":"QuickResponseDataProvider", + "documentation":"

The updated content of the quick response.

" + }, + "contentType":{ + "shape":"QuickResponseType", + "documentation":"

The media type of the quick response content.

  • Use application/x.quickresponse;format=plain for quick response written in plain text.

  • Use application/x.quickresponse;format=markdown for quick response written in richtext.

" + }, + "description":{ + "shape":"QuickResponseDescription", + "documentation":"

The updated description of the quick response.

" + }, + "groupingConfiguration":{ + "shape":"GroupingConfiguration", + "documentation":"

The updated grouping configuration of the quick response.

" + }, + "isActive":{ + "shape":"Boolean", + "documentation":"

Whether the quick response is active.

" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"

The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

" + }, + "name":{ + "shape":"QuickResponseName", + "documentation":"

The name of the quick response.

" + }, + "quickResponseId":{ + "shape":"UuidOrArn", + "documentation":"

The identifier of the quick response.

", + "location":"uri", + "locationName":"quickResponseId" + }, + "removeDescription":{ + "shape":"Boolean", + "documentation":"

Whether to remove the description from the quick response.

" + }, + "removeGroupingConfiguration":{ + "shape":"Boolean", + "documentation":"

Whether to remove the grouping configuration of the quick response.

" + }, + "removeShortcutKey":{ + "shape":"Boolean", + "documentation":"

Whether to remove the shortcut key of the quick response.

" + }, + "shortcutKey":{ + "shape":"ShortCutKey", + "documentation":"

The shortcut key of the quick response. The value should be unique across the knowledge base.

" + } + } + }, + "UpdateQuickResponseResponse":{ + "type":"structure", + "members":{ + "quickResponse":{ + "shape":"QuickResponseData", + "documentation":"

The quick response.

" + } + } + }, + "UploadId":{ + "type":"string", + "max":1200, + "min":1 + }, + "Uri":{ + "type":"string", + "max":4096, + "min":1 + }, + "Url":{ + "type":"string", + "max":4096, + "min":1, + "sensitive":true + }, + "Uuid":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + }, + "UuidOrArn":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$" + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The input fails to satisfy the constraints specified by a service.

", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "WaitTimeSeconds":{ + "type":"integer", + "max":20, + "min":0 + } + }, + "documentation":"

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.

Amazon Q automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q directly using natural language or keywords to answer customer requests.

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.

" +} diff --git a/botocore/data/s3/2006-03-01/endpoint-rule-set-1.json b/botocore/data/s3/2006-03-01/endpoint-rule-set-1.json index 0adf21daa1..d1bf31a598 100644 --- a/botocore/data/s3/2006-03-01/endpoint-rule-set-1.json +++ b/botocore/data/s3/2006-03-01/endpoint-rule-set-1.json @@ -85,6 +85,16 @@ "required": false, "documentation": "When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN's region when constructing the endpoint instead of the client's configured region.", "type": "Boolean" + }, + "UseS3ExpressControlEndpoint": { + "required": false, + "documentation": "Internal parameter to indicate whether S3Express operation should use control plane, (ex. CreateBucket)", + "type": "Boolean" + }, + "DisableS3ExpressSessionAuth": { + "required": false, + "documentation": "Parameter to indicate whether S3Express session auth should be disabled", + "type": "Boolean" } }, "rules": [ @@ -232,6 +242,944 @@ "error": "Partition does not support FIPS", "type": "error" }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Bucket" + } + ] + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 0, + 6, + true + ], + "assign": "bucketSuffix" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "bucketSuffix" + }, + "--x-s3" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "S3Express does not support Dual-stack.", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + } + ], + "error": "S3Express does not support S3 Accelerate.", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "isIp" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "uriEncode", + "argv": [ + { + "ref": "Bucket" + } + ], + "assign": "uri_encoded_bucket" + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{url#authority}/{uri_encoded_bucket}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "aws.isVirtualHostableS3Bucket", + "argv": [ + { + "ref": "Bucket" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{Bucket}.{url#authority}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "S3Express bucket name is not a valid virtual hostable name.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "isIp" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "uriEncode", + "argv": [ + { + "ref": "Bucket" + } + ], + "assign": "uri_encoded_bucket" + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{url#authority}/{uri_encoded_bucket}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "aws.isVirtualHostableS3Bucket", + "argv": [ + { + "ref": "Bucket" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{Bucket}.{url#authority}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "S3Express bucket name is not a valid virtual hostable name.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "UseS3ExpressControlEndpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseS3ExpressControlEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "uriEncode", + "argv": [ + { + "ref": "Bucket" + } + ], + "assign": "uri_encoded_bucket" + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://s3express-control-fips.{Region}.amazonaws.com/{uri_encoded_bucket}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.amazonaws.com/{uri_encoded_bucket}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "aws.isVirtualHostableS3Bucket", + "argv": [ + { + "ref": "Bucket" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 14, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 14, + 16, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 15, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 15, + 17, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Unrecognized S3Express bucket name format.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 14, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 14, + 16, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 15, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 15, + 17, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Unrecognized S3Express bucket name format.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "S3Express bucket name is not a valid virtual hostable name.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Bucket" + } + ] + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "UseS3ExpressControlEndpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseS3ExpressControlEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://s3express-control-fips.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.amazonaws.com", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, { "conditions": [ { diff --git a/botocore/data/s3/2006-03-01/paginators-1.json b/botocore/data/s3/2006-03-01/paginators-1.json index 1f061380f3..15bc1131ae 100644 --- a/botocore/data/s3/2006-03-01/paginators-1.json +++ b/botocore/data/s3/2006-03-01/paginators-1.json @@ -59,6 +59,12 @@ "output_token": "NextPartNumberMarker", "input_token": "PartNumberMarker", "result_key": "Parts" + }, + "ListDirectoryBuckets": { + "input_token": "ContinuationToken", + "limit_key": "MaxDirectoryBuckets", + "output_token": "ContinuationToken", + "result_key": "Buckets" } } } diff --git a/botocore/data/s3/2006-03-01/service-2.json b/botocore/data/s3/2006-03-01/service-2.json index 0064226545..3ccb84ea93 100644 --- a/botocore/data/s3/2006-03-01/service-2.json +++ b/botocore/data/s3/2006-03-01/service-2.json @@ -26,7 +26,7 @@ {"shape":"NoSuchUpload"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html", - "documentation":"

This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts action and ensure that the parts list is empty.

For information about permissions required to use the multipart upload, see Multipart Upload and Permissions.

The following operations are related to AbortMultipartUpload:

" + "documentation":"

This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

To verify that all parts have been removed and prevent getting charged for the part storage, you should call the ListParts API operation and ensure that the parts list is empty.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to AbortMultipartUpload:

" }, "CompleteMultipartUpload":{ "name":"CompleteMultipartUpload", @@ -37,7 +37,7 @@ "input":{"shape":"CompleteMultipartUploadRequest"}, "output":{"shape":"CompleteMultipartUploadOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html", - "documentation":"

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded.

Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. A request could fail after the initial 200 OK response has been sent. This means that a 200 OK response can contain either a success or an error. If you call the S3 API directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throws an exception (or, for the SDKs that don't use exceptions, they return the error).

Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

You cannot use Content-Type: application/x-www-form-urlencoded with Complete Multipart Upload requests. Also, if you do not provide a Content-Type header, CompleteMultipartUpload returns a 200 OK response.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload.

For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions.

CompleteMultipartUpload has the following special errors:

  • Error code: EntityTooSmall

    • Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.

    • 400 Bad Request

  • Error code: InvalidPart

    • Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.

    • 400 Bad Request

  • Error code: InvalidPartOrder

    • Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.

    • 400 Bad Request

  • Error code: NoSuchUpload

    • Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • 404 Not Found

The following operations are related to CompleteMultipartUpload:

" + "documentation":"

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the UploadPart operation or the UploadPartCopy operation. After successfully uploading all relevant parts of an upload, you call this CompleteMultipartUpload operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the CompleteMultipartUpload request, you must provide the parts list and ensure that the parts list is complete. The CompleteMultipartUpload API operation concatenates the parts that you provide in the list. For each part in the list, you must provide the PartNumber value and the ETag value that are returned after that part was uploaded.

The processing of a CompleteMultipartUpload request could take several minutes to finalize. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. A request could fail after the initial 200 OK response has been sent. This means that a 200 OK response can contain either a success or an error. The error response might be embedded in the 200 OK response. If you call this API operation directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an error).

Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

You can't use Content-Type: application/x-www-form-urlencoded for the CompleteMultipartUpload requests. Also, if you don't provide a Content-Type header, CompleteMultipartUpload can still return a 200 OK response.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Special errors

  • Error Code: EntityTooSmall

    • Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.

    • HTTP Status Code: 400 Bad Request

  • Error Code: InvalidPart

    • Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified ETag might not have matched the uploaded part's ETag.

    • HTTP Status Code: 400 Bad Request

  • Error Code: InvalidPartOrder

    • Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.

    • HTTP Status Code: 400 Bad Request

  • Error Code: NoSuchUpload

    • Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • HTTP Status Code: 404 Not Found

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to CompleteMultipartUpload:

" }, "CopyObject":{ "name":"CopyObject", @@ -51,8 +51,11 @@ {"shape":"ObjectNotInActiveTierError"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html", - "documentation":"

Creates a copy of an object that is already stored in Amazon S3.

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API.

All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. If you call the S3 API directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throws an exception (or, for the SDKs that don't use exceptions, they return the error).

If the copy is successful, you receive a response with information about the copied object.

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.

The copy request charge is based on the storage class and Region that you specify for the destination object. The request can also result in a data retrieval charge for the source if the source storage class bills for data retrieval. For pricing information, see Amazon S3 pricing.

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration.
Metadata

When copying an object, you can preserve all metadata (the default) or specify new metadata. However, the access control list (ACL) is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.

To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.

x-amz-website-redirect-location is unique to each object and must be specified in the request headers to copy the value.
x-amz-copy-source-if Headers

To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the following request parameters:

  • x-amz-copy-source-if-match

  • x-amz-copy-source-if-none-match

  • x-amz-copy-source-if-unmodified-since

  • x-amz-copy-source-if-modified-since

If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

  • x-amz-copy-source-if-match condition evaluates to true

  • x-amz-copy-source-if-unmodified-since condition evaluates to false

If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code:

  • x-amz-copy-source-if-none-match condition evaluates to false

  • x-amz-copy-source-if-modified-since condition evaluates to true

All headers with the x-amz- prefix, including x-amz-copy-source, must be signed.
Server-side encryption

Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you don't specify encryption information in your copy request, the encryption setting of the target object is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target object copy.

When you perform a CopyObject operation, if you want to use a different type of encryption setting for the target object, you can use other appropriate encryption-related headers to encrypt the target object with a KMS key, an Amazon S3 managed key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data centers and decrypts the data when you access it. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence. If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying. For more information about server-side encryption, see Using Server-Side Encryption.

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Access Control List (ACL)-Specific Request Headers

When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups that are defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format.

For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.
Checksums

When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you can optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header.

Storage Class Options

You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 by using the StorageClass parameter. For more information, see Storage Classes in the Amazon S3 User Guide.

If the source object's storage class is GLACIER or DEEP_ARCHIVE, or the object's storage class is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject. For more information, see Copying Objects.

Versioning

By default, x-amz-copy-source header identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId subresource.

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response.

If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.

The following operations are related to CopyObject:

", - "alias":"PutObjectCopy" + "documentation":"

Creates a copy of an object that is already stored in Amazon S3.

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API.

You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration.
Authentication and authorization

All CopyObject requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory buckets - You must use the IAM credentials to authenticate and authorize your access to the CopyObject API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

You must have read access to the source object and write access to the destination bucket.

  • General purpose bucket permissions - You must have permissions in an IAM policy based on the source and destination bucket types in a CopyObject operation.

    • If the source object is in a general purpose bucket, you must have s3:GetObject permission to read the source object that is being copied.

    • If the destination bucket is a general purpose bucket, you must have s3:PubObject permission to write the object copy to the destination bucket.

  • Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in a CopyObject operation.

    • If the source object that you want to copy is in a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to read the object. By default, the session is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode condition key to ReadOnly on the copy source bucket.

    • If the copy destination is a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to write the object to the destination. The s3express:SessionMode condition key can't be set to ReadOnly on the copy destination bucket.

    For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

Response and special errors

When the request is an HTTP 1.1 request, the response is chunk encoded. When the request is not an HTTP 1.1 request, the response would not contain the Content-Length. You always need to read the entire response body to check if the copy succeeds. to keep the connection alive while we copy the data.

  • If the copy is successful, you receive a response with information about the copied object.

  • A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. A 200 OK response can contain either a success or an error.

    • If the error occurs before the copy action starts, you receive a standard Amazon S3 error.

    • If the error occurs during the copy operation, the error response is embedded in the 200 OK response. For example, in a cross-region copy, you may encounter throttling and receive a 200 OK response. For more information, see Resolve the Error 200 response when copying objects to Amazon S3. The 200 OK status code means the copy was accepted, but it doesn't mean the copy is complete. Another example is when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and you may receive a 200 OK response. You must stay connected to Amazon S3 until the entire response is successfully received and processed.

      If you call this API operation directly, make sure to design your application to parse the content of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an error).

Charge

The copy request charge is based on the storage class and Region that you specify for the destination object. The request can also result in a data retrieval charge for the source if the source storage class bills for data retrieval. For pricing information, see Amazon S3 pricing.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to CopyObject:

", + "alias":"PutObjectCopy", + "staticContextParams":{ + "DisableS3ExpressSessionAuth":{"value":true} + } }, "CreateBucket":{ "name":"CreateBucket", @@ -67,10 +70,11 @@ {"shape":"BucketAlreadyOwnedByYou"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html", - "documentation":"

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Bucket naming rules.

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. To constrain the bucket creation to a specific Region, you can use LocationConstraint condition key. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see Accessing a bucket.

If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets.
Permissions

In addition to s3:CreateBucket, the following permissions are required when your CreateBucket request includes specific headers:

  • Access control lists (ACLs) - If your CreateBucket request specifies access control list (ACL) permissions and the ACL is public-read, public-read-write, authenticated-read, or if you specify access permissions explicitly through any other ACL, both s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL for the CreateBucket request is private or if the request doesn't specify any ACLs, only s3:CreateBucket permission is needed.

  • Object Lock - If ObjectLockEnabledForBucket is set to true in your CreateBucket request, s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.

  • S3 Object Ownership - If your CreateBucket request includes the x-amz-object-ownership header, then the s3:PutBucketOwnershipControls permission is required. By default, ObjectOwnership is set to BucketOWnerEnforced and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. If you want to change the ObjectOwnership setting, you can use the x-amz-object-ownership header in your CreateBucket request to set the ObjectOwnership setting of your choice. For more information about S3 Object Ownership, see Controlling object ownership in the Amazon S3 User Guide.

  • S3 Block Public Access - If your specific use case requires granting public access to your S3 resources, you can disable Block Public Access. You can create a new bucket with Block Public Access enabled, then separately call the DeletePublicAccessBlock API. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. By default, all Block Public Access settings are enabled for new buckets. To avoid inadvertent exposure of your resources, we recommend keeping the S3 Block Public Access settings enabled. For more information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.

If your CreateBucket request sets BucketOwnerEnforced for Amazon S3 Object Ownership and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a 400 error and returns the InvalidBucketAcLWithObjectOwnership error code. For more information, see Setting Object Ownership on an existing bucket in the Amazon S3 User Guide.

The following operations are related to CreateBucket:

", + "documentation":"

This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see CreateBucket .

Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

There are two types of buckets: general purpose buckets and directory buckets. For more information about these bucket types, see Creating, configuring, and working with Amazon S3 buckets in the Amazon S3 User Guide.

  • General purpose buckets - If you send your CreateBucket request to the s3.amazonaws.com global endpoint, the request goes to the us-east-1 Region. So the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets in the Amazon S3 User Guide.

  • Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - In addition to the s3:CreateBucket permission, the following permissions are required in a policy when your CreateBucket request includes specific headers:

    • Access control lists (ACLs) - In your CreateBucket request, if you specify an access control list (ACL) and set it to public-read, public-read-write, authenticated-read, or if you explicitly specify any other custom ACLs, both s3:CreateBucket and s3:PutBucketAcl permissions are required. In your CreateBucket request, if you set the ACL to private, or if you don't specify any ACLs, only the s3:CreateBucket permission is required.

    • Object Lock - In your CreateBucket request, if you set x-amz-bucket-object-lock-enabled to true, the s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.

    • S3 Object Ownership - If your CreateBucket request includes the x-amz-object-ownership header, then the s3:PutBucketOwnershipControls permission is required.

      If your CreateBucket request sets BucketOwnerEnforced for Amazon S3 Object Ownership and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a 400 error and returns the InvalidBucketAcLWithObjectOwnership error code. For more information, see Setting Object Ownership on an existing bucket in the Amazon S3 User Guide.

    • S3 Block Public Access - If your specific use case requires granting public access to your S3 resources, you can disable Block Public Access. Specifically, you can create a new bucket with Block Public Access enabled, then separately call the DeletePublicAccessBlock API. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.

  • Directory bucket permissions - You must have the s3express:CreateBucket permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 Block Public Access are not supported for directory buckets. For directory buckets, all Block Public Access settings are enabled at the bucket level and S3 Object Ownership is set to Bucket owner enforced (ACLs disabled). These settings can't be modified.

    For more information about permissions for creating and working with directory buckets, see Directory buckets in the Amazon S3 User Guide. For more information about supported S3 features for directory buckets, see Features of S3 Express One Zone in the Amazon S3 User Guide.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to CreateBucket:

", "alias":"PutBucket", "staticContextParams":{ - "DisableAccessPoints":{"value":true} + "DisableAccessPoints":{"value":true}, + "UseS3ExpressControlEndpoint":{"value":true} } }, "CreateMultipartUpload":{ @@ -82,9 +86,25 @@ "input":{"shape":"CreateMultipartUploadRequest"}, "output":{"shape":"CreateMultipartUploadOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html", - "documentation":"

This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.

For more information about multipart uploads, see Multipart Upload Overview.

If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions.

For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4).

After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.

Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. Amazon S3 automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a multipart upload, if you don't specify encryption information in your request, the encryption setting of the uploaded parts is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded parts. When you perform a CreateMultipartUpload operation, if you want to use a different type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the object with a KMS key, an Amazon S3 managed key, or a customer-provided key. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. You can request that Amazon S3 save the uploaded parts encrypted with server-side encryption with an Amazon S3 managed key (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C).

To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions and Protecting data using server-side encryption with Amazon Web Services KMS in the Amazon S3 User Guide.

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.

For more information, see Protecting Data Using Server-Side Encryption.

Access Permissions

When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:

  • Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Server-Side- Encryption-Specific Request Headers

Amazon S3 encrypts data by using server-side encryption with an Amazon S3 managed key (SSE-S3) by default. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can request that Amazon S3 encrypts data at rest by using server-side encryption with other key options. The option you use depends on whether you want to use KMS keys (SSE-KMS) or provide your own encryption keys (SSE-C).

  • Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (aws/s3) and KMS customer managed keys stored in Key Management Service (KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.

    • x-amz-server-side-encryption

    • x-amz-server-side-encryption-aws-kms-key-id

    • x-amz-server-side-encryption-context

    If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3 key) in KMS to protect the data.

    All GET and PUT requests for an object protected by KMS fail if you don't make them by using Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version 4.

    For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys.

  • Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption keys, provide all the following headers in the request.

    • x-amz-server-side-encryption-customer-algorithm

    • x-amz-server-side-encryption-customer-key

    • x-amz-server-side-encryption-customer-key-MD5

    For more information about server-side encryption with customer-provided encryption keys (SSE-C), see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).

Access-Control-List (ACL)-Specific Request Headers

You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:

  • Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.

  • Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:

    • x-amz-grant-read

    • x-amz-grant-write

    • x-amz-grant-read-acp

    • x-amz-grant-write-acp

    • x-amz-grant-full-control

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"

The following operations are related to CreateMultipartUpload:

", + "documentation":"

This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.

After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stops charging you for storing them only after you either complete or abort a multipart upload.

If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart upload must be completed within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

  • Directory buckets - S3 Lifecycle is not supported by directory buckets.

  • Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Request signing

For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 User Guide.

Permissions

  • General purpose bucket permissions - For information about the permissions required to use the multipart upload API, see Multipart upload and permissions in the Amazon S3 User Guide.

    To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions and Protecting data using server-side encryption with Amazon Web Services KMS in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Encryption

  • General purpose buckets - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. Amazon S3 automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a multipart upload, if you don't specify encryption information in your request, the encryption setting of the uploaded parts is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded parts. When you perform a CreateMultipartUpload operation, if you want to use a different type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the object with a different encryption key (such as an Amazon S3 managed key, a KMS key, or a customer-provided key). When the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the CreateMultipartUpload request.

    • Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (aws/s3) and KMS customer managed keys stored in Key Management Service (KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.

      • x-amz-server-side-encryption

      • x-amz-server-side-encryption-aws-kms-key-id

      • x-amz-server-side-encryption-context

      • If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3 key) in KMS to protect the data.

      • To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions and Protecting data using server-side encryption with Amazon Web Services KMS in the Amazon S3 User Guide.

      • If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role is in a different account from the key, then you must have the permissions on both the key policy and your IAM user or role.

      • All GET and PUT requests for an object protected by KMS fail if you don't make them by using Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version 4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

      For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys in the Amazon S3 User Guide.

    • Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption keys, provide all the following headers in the request.

      • x-amz-server-side-encryption-customer-algorithm

      • x-amz-server-side-encryption-customer-key

      • x-amz-server-side-encryption-customer-key-MD5

      For more information about server-side encryption with customer-provided encryption keys (SSE-C), see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C) in the Amazon S3 User Guide.

  • Directory buckets -For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to CreateMultipartUpload:

", "alias":"InitiateMultipartUpload" }, + "CreateSession":{ + "name":"CreateSession", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?session" + }, + "input":{"shape":"CreateSessionRequest"}, + "output":{"shape":"CreateSessionOutput"}, + "errors":[ + {"shape":"NoSuchBucket"} + ], + "documentation":"

Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint APIs on directory buckets. For more information about Zonal endpoint APIs that include the Availability Zone in the request endpoint, see S3 Express One Zone APIs in the Amazon S3 User Guide.

To make Zonal endpoint API requests on a directory bucket, use the CreateSession API operation. Specifically, you grant s3express:CreateSession permission to a bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the CreateSession API request on the bucket, which returns temporary security credentials that include the access key ID, secret access key, session token, and expiration. These credentials have associated permissions to access the Zonal endpoint APIs. After the session is created, you don’t need to use other policies to grant permissions to each Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by applying the temporary security credentials of the session to the request headers and following the SigV4 protocol for authentication. You also apply the session token to the x-amz-s3session-token request header for authorization. Temporary security credentials are scoped to the bucket and expire after 5 minutes. After the expiration time, any calls that you make with those credentials will fail. You must use IAM credentials again to make a CreateSession API request that generates a new set of temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond the original specified interval.

If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to initiate and manage requests to the CreateSession API. For more information, see Performance guidelines and design patterns in the Amazon S3 User Guide.

  • You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

  • CopyObject API operation - Unlike other Zonal endpoint APIs, the CopyObject API operation doesn't use the temporary security credentials returned from the CreateSession API operation for authentication and authorization. For information about authentication and authorization of the CopyObject API operation on directory buckets, see CopyObject.

  • HeadBucket API operation - Unlike other Zonal endpoint APIs, the HeadBucket API operation doesn't use the temporary security credentials returned from the CreateSession API operation for authentication and authorization. For information about authentication and authorization of the HeadBucket API operation on directory buckets, see HeadBucket.
Permissions

To obtain temporary security credentials, you must create a bucket policy or an IAM identity-based policy that grants s3express:CreateSession permission to the bucket. In a policy, you can have the s3express:SessionMode condition key to control who can create a ReadWrite or ReadOnly session. For more information about ReadWrite or ReadOnly sessions, see x-amz-create-session-mode . For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

To grant cross-account access to Zonal endpoint APIs, the bucket policy should also grant both accounts the s3express:CreateSession permission.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

", + "staticContextParams":{ + "DisableS3ExpressSessionAuth":{"value":true} + } + }, "DeleteBucket":{ "name":"DeleteBucket", "http":{ @@ -94,7 +114,10 @@ }, "input":{"shape":"DeleteBucketRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html", - "documentation":"

Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

The following operations are related to DeleteBucket:

" + "documentation":"

Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

  • Directory buckets - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.

  • Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - You must have the s3:DeleteBucket permission on the specified bucket in a policy.

  • Directory bucket permissions - You must have the s3express:DeleteBucket permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to DeleteBucket:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketAnalyticsConfiguration":{ "name":"DeleteBucketAnalyticsConfiguration", @@ -104,7 +127,10 @@ "responseCode":204 }, "input":{"shape":"DeleteBucketAnalyticsConfigurationRequest"}, - "documentation":"

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to DeleteBucketAnalyticsConfiguration:

" + "documentation":"

This operation is not supported by directory buckets.

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to DeleteBucketAnalyticsConfiguration:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketCors":{ "name":"DeleteBucketCors", @@ -115,7 +141,10 @@ }, "input":{"shape":"DeleteBucketCorsRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html", - "documentation":"

Deletes the cors configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others.

For information about cors, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Related Resources

" + "documentation":"

This operation is not supported by directory buckets.

Deletes the cors configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others.

For information about cors, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Related Resources

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketEncryption":{ "name":"DeleteBucketEncryption", @@ -125,7 +154,10 @@ "responseCode":204 }, "input":{"shape":"DeleteBucketEncryptionRequest"}, - "documentation":"

This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The 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 and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

The following operations are related to DeleteBucketEncryption:

" + "documentation":"

This operation is not supported by directory buckets.

This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The 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 and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

The following operations are related to DeleteBucketEncryption:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketIntelligentTieringConfiguration":{ "name":"DeleteBucketIntelligentTieringConfiguration", @@ -135,7 +167,10 @@ "responseCode":204 }, "input":{"shape":"DeleteBucketIntelligentTieringConfigurationRequest"}, - "documentation":"

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to DeleteBucketIntelligentTieringConfiguration include:

" + "documentation":"

This operation is not supported by directory buckets.

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to DeleteBucketIntelligentTieringConfiguration include:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketInventoryConfiguration":{ "name":"DeleteBucketInventoryConfiguration", @@ -145,7 +180,10 @@ "responseCode":204 }, "input":{"shape":"DeleteBucketInventoryConfigurationRequest"}, - "documentation":"

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

Operations related to DeleteBucketInventoryConfiguration include:

" + "documentation":"

This operation is not supported by directory buckets.

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

Operations related to DeleteBucketInventoryConfiguration include:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketLifecycle":{ "name":"DeleteBucketLifecycle", @@ -156,7 +194,10 @@ }, "input":{"shape":"DeleteBucketLifecycleRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html", - "documentation":"

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

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

There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.

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

Related actions include:

" + "documentation":"

This operation is not supported by directory buckets.

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

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

There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.

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

Related actions include:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketMetricsConfiguration":{ "name":"DeleteBucketMetricsConfiguration", @@ -166,7 +207,10 @@ "responseCode":204 }, "input":{"shape":"DeleteBucketMetricsConfigurationRequest"}, - "documentation":"

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to DeleteBucketMetricsConfiguration:

" + "documentation":"

This operation is not supported by directory buckets.

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to DeleteBucketMetricsConfiguration:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketOwnershipControls":{ "name":"DeleteBucketOwnershipControls", @@ -176,7 +220,10 @@ "responseCode":204 }, "input":{"shape":"DeleteBucketOwnershipControlsRequest"}, - "documentation":"

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to DeleteBucketOwnershipControls:

" + "documentation":"

This operation is not supported by directory buckets.

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to DeleteBucketOwnershipControls:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketPolicy":{ "name":"DeleteBucketPolicy", @@ -187,7 +234,10 @@ }, "input":{"shape":"DeleteBucketPolicyRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html", - "documentation":"

This implementation of the DELETE action uses the policy subresource to delete the policy of a specified 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 DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account to use this operation.

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.

To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

For more information about bucket policies, see Using Bucket Policies and UserPolicies.

The following operations are related to DeleteBucketPolicy

" + "documentation":"

Deletes the policy of a specified bucket.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

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 both have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

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.

To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

  • General purpose bucket permissions - The s3:DeleteBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:DeleteBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to DeleteBucketPolicy

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketReplication":{ "name":"DeleteBucketReplication", @@ -197,7 +247,10 @@ "responseCode":204 }, "input":{"shape":"DeleteBucketReplicationRequest"}, - "documentation":"

Deletes the replication configuration from the bucket.

To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

It can take a while for the deletion of a replication configuration to fully propagate.

For information about replication configuration, see Replication in the Amazon S3 User Guide.

The following operations are related to DeleteBucketReplication:

" + "documentation":"

This operation is not supported by directory buckets.

Deletes the replication configuration from the bucket.

To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

It can take a while for the deletion of a replication configuration to fully propagate.

For information about replication configuration, see Replication in the Amazon S3 User Guide.

The following operations are related to DeleteBucketReplication:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketTagging":{ "name":"DeleteBucketTagging", @@ -208,7 +261,10 @@ }, "input":{"shape":"DeleteBucketTaggingRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html", - "documentation":"

Deletes the tags from the bucket.

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

The following operations are related to DeleteBucketTagging:

" + "documentation":"

This operation is not supported by directory buckets.

Deletes the tags from the bucket.

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

The following operations are related to DeleteBucketTagging:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteBucketWebsite":{ "name":"DeleteBucketWebsite", @@ -219,7 +275,10 @@ }, "input":{"shape":"DeleteBucketWebsiteRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html", - "documentation":"

This action removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

This DELETE action requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

For more information about hosting websites, see Hosting Websites on Amazon S3.

The following operations are related to DeleteBucketWebsite:

" + "documentation":"

This operation is not supported by directory buckets.

This action removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

This DELETE action requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

For more information about hosting websites, see Hosting Websites on Amazon S3.

The following operations are related to DeleteBucketWebsite:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "DeleteObject":{ "name":"DeleteObject", @@ -231,7 +290,7 @@ "input":{"shape":"DeleteObjectRequest"}, "output":{"shape":"DeleteObjectOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html", - "documentation":"

Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects but will still respond that the command was successful.

To remove a specific version, you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, to true.

If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS.

For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.

You can delete objects by explicitly calling DELETE Object or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions.

The following action is related to DeleteObject:

" + "documentation":"

Removes an object from a bucket. The behavior depends on the bucket's versioning state:

  • If versioning is enabled, the operation removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects but will still respond that the command was successful.

  • If versioning is suspended or not enabled, the operation permanently deletes the object.

  • Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

  • Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

To remove a specific version, you must use the versionId query parameter. Using this query parameter permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header x-amz-delete-marker to true.

If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS. For more information about MFA Delete, see Using MFA Delete in the Amazon S3 User Guide. To see sample requests that use versioning, see Sample Request.

Directory buckets - MFA delete is not supported by directory buckets.

You can delete objects by explicitly calling DELETE Object or calling (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions.

Directory buckets - S3 Lifecycle is not supported by directory buckets.
Permissions

  • General purpose bucket permissions - The following permissions are required in your policies when your DeleteObjects request includes specific headers.

    • s3:DeleteObject - To delete an object from a bucket, you must always have the s3:DeleteObject permission.

    • s3:DeleteObjectVersion - To delete a specific version of an object from a versiong-enabled bucket, you must have the s3:DeleteObjectVersion permission.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following action is related to DeleteObject:

" }, "DeleteObjectTagging":{ "name":"DeleteObjectTagging", @@ -242,7 +301,7 @@ }, "input":{"shape":"DeleteObjectTaggingRequest"}, "output":{"shape":"DeleteObjectTaggingOutput"}, - "documentation":"

Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.

To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.

To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action.

The following operations are related to DeleteObjectTagging:

" + "documentation":"

This operation is not supported by directory buckets.

Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.

To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.

To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action.

The following operations are related to DeleteObjectTagging:

" }, "DeleteObjects":{ "name":"DeleteObjects", @@ -253,7 +312,7 @@ "input":{"shape":"DeleteObjectsRequest"}, "output":{"shape":"DeleteObjectsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html", - "documentation":"

This action enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this action provides a suitable alternative to sending individual delete requests, reducing per-request overhead.

The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.

The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete action encountered an error. For a successful deletion, the action does not return any information about the delete in the response body.

When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.

Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.

The following operations are related to DeleteObjects:

", + "documentation":"

This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.

The request can contain a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.

  • Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.

  • Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion in a quiet mode, the operation does not return any information about the delete in the response body.

When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete in the Amazon S3 User Guide.

Directory buckets - MFA delete is not supported by directory buckets.
Permissions

  • General purpose bucket permissions - The following permissions are required in your policies when your DeleteObjects request includes specific headers.

    • s3:DeleteObject - To delete an object from a bucket, you must always specify the s3:DeleteObject permission.

    • s3:DeleteObjectVersion - To delete a specific version of an object from a versiong-enabled bucket, you must specify the s3:DeleteObjectVersion permission.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Content-MD5 request header

  • General purpose bucket - The Content-MD5 request header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.

  • Directory bucket - The Content-MD5 request header or a additional checksum request header (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1, or x-amz-checksum-sha256) is required for all Multi-Object Delete requests.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to DeleteObjects:

", "alias":"DeleteMultipleObjects", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", @@ -268,7 +327,10 @@ "responseCode":204 }, "input":{"shape":"DeletePublicAccessBlockRequest"}, - "documentation":"

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to DeletePublicAccessBlock:

" + "documentation":"

This operation is not supported by directory buckets.

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to DeletePublicAccessBlock:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketAccelerateConfiguration":{ "name":"GetBucketAccelerateConfiguration", @@ -278,7 +340,10 @@ }, "input":{"shape":"GetBucketAccelerateConfigurationRequest"}, "output":{"shape":"GetBucketAccelerateConfigurationOutput"}, - "documentation":"

This implementation of the GET action uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.

To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action. The 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 and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended by using the PutBucketAccelerateConfiguration operation.

A GET accelerate request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.

For more information about transfer acceleration, see Transfer Acceleration in the Amazon S3 User Guide.

The following operations are related to GetBucketAccelerateConfiguration:

" + "documentation":"

This operation is not supported by directory buckets.

This implementation of the GET action uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.

To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action. The 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 and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended by using the PutBucketAccelerateConfiguration operation.

A GET accelerate request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.

For more information about transfer acceleration, see Transfer Acceleration in the Amazon S3 User Guide.

The following operations are related to GetBucketAccelerateConfiguration:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketAcl":{ "name":"GetBucketAcl", @@ -289,7 +354,10 @@ "input":{"shape":"GetBucketAclRequest"}, "output":{"shape":"GetBucketAclOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html", - "documentation":"

This implementation of the GET action uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

The following operations are related to GetBucketAcl:

" + "documentation":"

This operation is not supported by directory buckets.

This implementation of the GET action uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have the READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

The following operations are related to GetBucketAcl:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketAnalyticsConfiguration":{ "name":"GetBucketAnalyticsConfiguration", @@ -299,7 +367,10 @@ }, "input":{"shape":"GetBucketAnalyticsConfigurationRequest"}, "output":{"shape":"GetBucketAnalyticsConfigurationOutput"}, - "documentation":"

This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.

The following operations are related to GetBucketAnalyticsConfiguration:

" + "documentation":"

This operation is not supported by directory buckets.

This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.

The following operations are related to GetBucketAnalyticsConfiguration:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketCors":{ "name":"GetBucketCors", @@ -310,7 +381,10 @@ "input":{"shape":"GetBucketCorsRequest"}, "output":{"shape":"GetBucketCorsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html", - "documentation":"

Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

For more information about CORS, see Enabling Cross-Origin Resource Sharing.

The following operations are related to GetBucketCors:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

For more information about CORS, see Enabling Cross-Origin Resource Sharing.

The following operations are related to GetBucketCors:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketEncryption":{ "name":"GetBucketEncryption", @@ -320,7 +394,10 @@ }, "input":{"shape":"GetBucketEncryptionRequest"}, "output":{"shape":"GetBucketEncryptionOutput"}, - "documentation":"

Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.

To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to GetBucketEncryption:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.

To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to GetBucketEncryption:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketIntelligentTieringConfiguration":{ "name":"GetBucketIntelligentTieringConfiguration", @@ -330,7 +407,10 @@ }, "input":{"shape":"GetBucketIntelligentTieringConfigurationRequest"}, "output":{"shape":"GetBucketIntelligentTieringConfigurationOutput"}, - "documentation":"

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to GetBucketIntelligentTieringConfiguration include:

" + "documentation":"

This operation is not supported by directory buckets.

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to GetBucketIntelligentTieringConfiguration include:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketInventoryConfiguration":{ "name":"GetBucketInventoryConfiguration", @@ -340,7 +420,10 @@ }, "input":{"shape":"GetBucketInventoryConfigurationRequest"}, "output":{"shape":"GetBucketInventoryConfigurationOutput"}, - "documentation":"

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The 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.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

" + "documentation":"

This operation is not supported by directory buckets.

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The 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.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketLifecycle":{ "name":"GetBucketLifecycle", @@ -351,8 +434,11 @@ "input":{"shape":"GetBucketLifecycleRequest"}, "output":{"shape":"GetBucketLifecycleOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html", - "documentation":"

For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter element, you should see the updated version of this topic. This topic is provided for backward compatibility.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycle 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 operations are related to GetBucketLifecycle:

", - "deprecated":true + "documentation":"

For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter element, you should see the updated version of this topic. This topic is provided for backward compatibility.

This operation is not supported by directory buckets.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycle 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 operations are related to GetBucketLifecycle:

", + "deprecated":true, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketLifecycleConfiguration":{ "name":"GetBucketLifecycleConfiguration", @@ -362,7 +448,10 @@ }, "input":{"shape":"GetBucketLifecycleConfigurationRequest"}, "output":{"shape":"GetBucketLifecycleConfigurationOutput"}, - "documentation":"

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see GetBucketLifecycle.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

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 operations are related to GetBucketLifecycleConfiguration:

" + "documentation":"

This operation is not supported by directory buckets.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see GetBucketLifecycle.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

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 operations are related to GetBucketLifecycleConfiguration:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketLocation":{ "name":"GetBucketLocation", @@ -373,7 +462,10 @@ "input":{"shape":"GetBucketLocationRequest"}, "output":{"shape":"GetBucketLocationOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html", - "documentation":"

Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request. For more information, see CreateBucket.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

We recommend that you use HeadBucket to return the Region that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.

The following operations are related to GetBucketLocation:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request. For more information, see CreateBucket.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

We recommend that you use HeadBucket to return the Region that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.

The following operations are related to GetBucketLocation:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketLogging":{ "name":"GetBucketLogging", @@ -384,7 +476,10 @@ "input":{"shape":"GetBucketLoggingRequest"}, "output":{"shape":"GetBucketLoggingOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html", - "documentation":"

Returns the logging status of a bucket and the permissions users have to view and modify that status.

The following operations are related to GetBucketLogging:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the logging status of a bucket and the permissions users have to view and modify that status.

The following operations are related to GetBucketLogging:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketMetricsConfiguration":{ "name":"GetBucketMetricsConfiguration", @@ -394,7 +489,10 @@ }, "input":{"shape":"GetBucketMetricsConfigurationRequest"}, "output":{"shape":"GetBucketMetricsConfigurationOutput"}, - "documentation":"

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to GetBucketMetricsConfiguration:

" + "documentation":"

This operation is not supported by directory buckets.

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to GetBucketMetricsConfiguration:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketNotification":{ "name":"GetBucketNotification", @@ -405,8 +503,11 @@ "input":{"shape":"GetBucketNotificationConfigurationRequest"}, "output":{"shape":"NotificationConfigurationDeprecated"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html", - "documentation":"

No longer used, see GetBucketNotificationConfiguration.

", - "deprecated":true + "documentation":"

This operation is not supported by directory buckets.

No longer used, see GetBucketNotificationConfiguration.

", + "deprecated":true, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketNotificationConfiguration":{ "name":"GetBucketNotificationConfiguration", @@ -416,7 +517,10 @@ }, "input":{"shape":"GetBucketNotificationConfigurationRequest"}, "output":{"shape":"NotificationConfiguration"}, - "documentation":"

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration element.

By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.

The following action is related to GetBucketNotification:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration element.

By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.

The following action is related to GetBucketNotification:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketOwnershipControls":{ "name":"GetBucketOwnershipControls", @@ -426,7 +530,10 @@ }, "input":{"shape":"GetBucketOwnershipControlsRequest"}, "output":{"shape":"GetBucketOwnershipControlsOutput"}, - "documentation":"

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to GetBucketOwnershipControls:

" + "documentation":"

This operation is not supported by directory buckets.

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to GetBucketOwnershipControls:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketPolicy":{ "name":"GetBucketPolicy", @@ -437,7 +544,10 @@ "input":{"shape":"GetBucketPolicyRequest"}, "output":{"shape":"GetBucketPolicyOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html", - "documentation":"

Returns the policy of a specified 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 GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have GetBucketPolicy 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.

To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

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

The following action is related to GetBucketPolicy:

" + "documentation":"

Returns the policy of a specified bucket.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

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 both have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have GetBucketPolicy 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.

To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

  • General purpose bucket permissions - The s3:GetBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:GetBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

Example bucket policies

General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.

Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following action is related to GetBucketPolicy:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketPolicyStatus":{ "name":"GetBucketPolicyStatus", @@ -447,7 +557,10 @@ }, "input":{"shape":"GetBucketPolicyStatusRequest"}, "output":{"shape":"GetBucketPolicyStatusOutput"}, - "documentation":"

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".

The following operations are related to GetBucketPolicyStatus:

" + "documentation":"

This operation is not supported by directory buckets.

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".

The following operations are related to GetBucketPolicyStatus:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketReplication":{ "name":"GetBucketReplication", @@ -457,7 +570,10 @@ }, "input":{"shape":"GetBucketReplicationRequest"}, "output":{"shape":"GetBucketReplicationOutput"}, - "documentation":"

Returns the replication configuration of a bucket.

It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

For information about replication configuration, see Replication in the Amazon S3 User Guide.

This action requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies.

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

For information about GetBucketReplication errors, see List of replication-related error codes

The following operations are related to GetBucketReplication:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the replication configuration of a bucket.

It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

For information about replication configuration, see Replication in the Amazon S3 User Guide.

This action requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies.

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

For information about GetBucketReplication errors, see List of replication-related error codes

The following operations are related to GetBucketReplication:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketRequestPayment":{ "name":"GetBucketRequestPayment", @@ -468,7 +584,10 @@ "input":{"shape":"GetBucketRequestPaymentRequest"}, "output":{"shape":"GetBucketRequestPaymentOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html", - "documentation":"

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

The following operations are related to GetBucketRequestPayment:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

The following operations are related to GetBucketRequestPayment:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketTagging":{ "name":"GetBucketTagging", @@ -479,7 +598,10 @@ "input":{"shape":"GetBucketTaggingRequest"}, "output":{"shape":"GetBucketTaggingOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html", - "documentation":"

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the s3: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: NoSuchTagSet

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

The following operations are related to GetBucketTagging:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the s3: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: NoSuchTagSet

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

The following operations are related to GetBucketTagging:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketVersioning":{ "name":"GetBucketVersioning", @@ -490,7 +612,10 @@ "input":{"shape":"GetBucketVersioningRequest"}, "output":{"shape":"GetBucketVersioningOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html", - "documentation":"

Returns the versioning state of a bucket.

To retrieve the versioning state of a bucket, you must be the bucket owner.

This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

The following operations are related to GetBucketVersioning:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the versioning state of a bucket.

To retrieve the versioning state of a bucket, you must be the bucket owner.

This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

The following operations are related to GetBucketVersioning:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetBucketWebsite":{ "name":"GetBucketWebsite", @@ -501,7 +626,10 @@ "input":{"shape":"GetBucketWebsiteRequest"}, "output":{"shape":"GetBucketWebsiteOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html", - "documentation":"

Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.

This GET action requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.

The following operations are related to GetBucketWebsite:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.

This GET action requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.

The following operations are related to GetBucketWebsite:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "GetObject":{ "name":"GetObject", @@ -516,7 +644,7 @@ {"shape":"InvalidObjectState"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html", - "documentation":"

Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header.

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.

To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification.

For more information about returning the ACL of an object, see GetObjectAcl.

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects.

Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 Bad Request error.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.

Permissions

You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object that you request doesn’t exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 (Not Found) error.

If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 (\"access denied\") error.

Versioning

By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource.

  • If you supply a versionId, you need the s3:GetObjectVersion permission to access a specific version of an object. If you request a specific version, you do not need to have the s3:GetObject permission. If you request the current version without a specific version ID, only s3:GetObject permission is required. s3:GetObjectVersion permission won't be required.

  • If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

  • If the specified version is a delete marker, the response returns a 405 (Method Not Allowed) error and the Last-Modified: timestamp response header.

For more information about versioning, see PutBucketVersioning.

Overriding Response Header Values

There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.

You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters.

You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.

  • response-content-type

  • response-content-language

  • response-expires

  • response-cache-control

  • response-content-disposition

  • response-content-encoding

Overriding Response Header Values

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

The following operations are related to GetObject:

", + "documentation":"

Retrieves an object from Amazon S3.

In the GetObject request, specify the full key name for the object.

General purpose buckets - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the object key name as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the object key name as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification in the Amazon S3 User Guide.

Directory buckets - Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket--use1-az5--x-s3, specify the object key name as /photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

Permissions

  • General purpose bucket permissions - You must have the required permissions in a policy. To use GetObject, you must have the READ access to the object (or version). If you grant READ access to the anonymous user, the GetObject operation returns the object without using an authorization header. For more information, see Specifying permissions in a policy in the Amazon S3 User Guide.

    If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.

    If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.

    If the object that you request doesn’t exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

    • If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found error.

    • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Access Denied error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Storage classes

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.

Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for the GetObject requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your GetObject requests for the object that uses these types of keys, you’ll get an HTTP 400 Bad Request error.

Overriding response header values through the request

There are times when you want to override certain response header values of a GetObject response. For example, you might override the Content-Disposition response header value through your GetObject request.

You can override values for a set of response headers. These modified response header values are included only in a successful response, that is, when the HTTP status code 200 OK is returned. The headers you can override using the following query parameters in the request are a subset of the headers that Amazon S3 accepts when you create an object.

The response headers that you can override for the GetObject response are Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, and Expires.

To override values for a set of response headers in the GetObject response, you can use the following query parameters in the request.

  • response-cache-control

  • response-content-disposition

  • response-content-encoding

  • response-content-language

  • response-content-type

  • response-expires

When you use these parameters, you must sign the request by using either an Authorization header or a presigned URL. These parameters cannot be used with an unsigned (anonymous) request.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to GetObject:

", "httpChecksum":{ "requestValidationModeMember":"ChecksumMode", "responseAlgorithms":[ @@ -539,7 +667,7 @@ {"shape":"NoSuchKey"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html", - "documentation":"

Returns the access control list (ACL) of an object. To use this operation, you must have s3:GetObjectAcl permissions or READ_ACP access to the object. For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3 User Guide

This action is not supported by Amazon S3 on Outposts.

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

The following operations are related to GetObjectAcl:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the access control list (ACL) of an object. To use this operation, you must have s3:GetObjectAcl permissions or READ_ACP access to the object. For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3 User Guide

This functionality is not supported for Amazon S3 on Outposts.

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

The following operations are related to GetObjectAcl:

" }, "GetObjectAttributes":{ "name":"GetObjectAttributes", @@ -552,7 +680,7 @@ "errors":[ {"shape":"NoSuchKey"} ], - "documentation":"

Retrieves all the metadata from an object without returning the object itself. This action is useful if you're interested only in an object's metadata. To use GetObjectAttributes, you must have READ access to the object.

GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

  • Encryption request headers, such as x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed keys (SSE-S3). If your object does use these types of keys, you'll get an HTTP 400 Bad Request error.

  • The last modified property in this case is the creation date of the object.

Consider the following when using request headers:

  • If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested:

    • If-Match condition evaluates to true.

    • If-Unmodified-Since condition evaluates to false.

  • If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified:

    • If-None-Match condition evaluates to false.

    • If-Modified-Since condition evaluates to true.

For more information about conditional requests, see RFC 7232.

Permissions

The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

  • If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found (\"no such key\") error.

  • If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden (\"access denied\") error.

The following actions are related to GetObjectAttributes:

" + "documentation":"

Retrieves all the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.

GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - To use GetObjectAttributes, you must have READ access to the object. The permissions that you need to use this operation with depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

    • If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found (\"no such key\") error.

    • If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden (\"access denied\") error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a GET request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

Directory bucket permissions - For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
Versioning

Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

Conditional request headers

Consider the following when using request headers:

  • If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested:

    • If-Match condition evaluates to true.

    • If-Unmodified-Since condition evaluates to false.

    For more information about conditional requests, see RFC 7232.

  • If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified:

    • If-None-Match condition evaluates to false.

    • If-Modified-Since condition evaluates to true.

    For more information about conditional requests, see RFC 7232.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following actions are related to GetObjectAttributes:

" }, "GetObjectLegalHold":{ "name":"GetObjectLegalHold", @@ -562,7 +690,7 @@ }, "input":{"shape":"GetObjectLegalHoldRequest"}, "output":{"shape":"GetObjectLegalHoldOutput"}, - "documentation":"

Gets an object's current legal hold status. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

The following action is related to GetObjectLegalHold:

" + "documentation":"

This operation is not supported by directory buckets.

Gets an object's current legal hold status. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectLegalHold:

" }, "GetObjectLockConfiguration":{ "name":"GetObjectLockConfiguration", @@ -572,7 +700,7 @@ }, "input":{"shape":"GetObjectLockConfigurationRequest"}, "output":{"shape":"GetObjectLockConfigurationOutput"}, - "documentation":"

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

The following action is related to GetObjectLockConfiguration:

" + "documentation":"

This operation is not supported by directory buckets.

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

The following action is related to GetObjectLockConfiguration:

" }, "GetObjectRetention":{ "name":"GetObjectRetention", @@ -582,7 +710,7 @@ }, "input":{"shape":"GetObjectRetentionRequest"}, "output":{"shape":"GetObjectRetentionOutput"}, - "documentation":"

Retrieves an object's retention settings. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

The following action is related to GetObjectRetention:

" + "documentation":"

This operation is not supported by directory buckets.

Retrieves an object's retention settings. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectRetention:

" }, "GetObjectTagging":{ "name":"GetObjectTagging", @@ -592,7 +720,7 @@ }, "input":{"shape":"GetObjectTaggingRequest"}, "output":{"shape":"GetObjectTaggingOutput"}, - "documentation":"

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

By default, the bucket owner has this permission and can grant this permission to others.

For information about the Amazon S3 object tagging feature, see Object Tagging.

The following actions are related to GetObjectTagging:

" + "documentation":"

This operation is not supported by directory buckets.

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

By default, the bucket owner has this permission and can grant this permission to others.

For information about the Amazon S3 object tagging feature, see Object Tagging.

The following actions are related to GetObjectTagging:

" }, "GetObjectTorrent":{ "name":"GetObjectTorrent", @@ -603,7 +731,7 @@ "input":{"shape":"GetObjectTorrentRequest"}, "output":{"shape":"GetObjectTorrentOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html", - "documentation":"

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.

You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.

To use GET, you must have READ access to the object.

This action is not supported by Amazon S3 on Outposts.

The following action is related to GetObjectTorrent:

" + "documentation":"

This operation is not supported by directory buckets.

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.

You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.

To use GET, you must have READ access to the object.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectTorrent:

" }, "GetPublicAccessBlock":{ "name":"GetPublicAccessBlock", @@ -613,7 +741,10 @@ }, "input":{"shape":"GetPublicAccessBlockRequest"}, "output":{"shape":"GetPublicAccessBlockOutput"}, - "documentation":"

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

The following operations are related to GetPublicAccessBlock:

" + "documentation":"

This operation is not supported by directory buckets.

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

The following operations are related to GetPublicAccessBlock:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "HeadBucket":{ "name":"HeadBucket", @@ -622,11 +753,12 @@ "requestUri":"/{Bucket}" }, "input":{"shape":"HeadBucketRequest"}, + "output":{"shape":"HeadBucketOutput"}, "errors":[ {"shape":"NoSuchBucket"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketHEAD.html", - "documentation":"

This action is useful to determine if a bucket exists and you have permission to access it. The action returns a 200 OK if the bucket exists and you have permission to access it.

If the bucket does not exist or you do not have permission to access it, the HEAD request returns a generic 400 Bad Request, 403 Forbidden or 404 Not Found code. A message body is not included, so you cannot determine the exception beyond these error codes.

To use this operation, you must have permissions to perform the s3:ListBucket action. The 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.

To use this API operation against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information, see Using access points.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

" + "documentation":"

You can use this operation to determine if a bucket exists and if you have permission to access it. The action returns a 200 OK if the bucket exists and you have permission to access it.

If the bucket does not exist or you do not have permission to access it, the HEAD request returns a generic 400 Bad Request, 403 Forbidden or 404 Not Found code. A message body is not included, so you cannot determine the exception beyond these error codes.

Directory buckets - You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Authentication and authorization

All HeadBucket requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory bucket - You must use IAM credentials to authenticate and authorize your access to the HeadBucket API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

" }, "HeadObject":{ "name":"HeadObject", @@ -640,7 +772,7 @@ {"shape":"NoSuchKey"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html", - "documentation":"

The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic code, such as 400 Bad Request, 403 Forbidden, 404 Not Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. It's not possible to retrieve the exact exception of these error codes.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

  • Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 Bad Request error.

  • The last modified property in this case is the creation date of the object.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

Consider the following when using request headers:

  • Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

    • If-Match condition evaluates to true, and;

    • If-Unmodified-Since condition evaluates to false;

    Then Amazon S3 returns 200 OK and the data requested.

  • Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

    • If-None-Match condition evaluates to false, and;

    • If-Modified-Since condition evaluates to true;

    Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Permissions

You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys for Amazon S3. If the object you request doesn't exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

  • If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 error.

  • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 error.

Versioning

  • If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

  • If the specified version is a delete marker, the response returns a 405 (Method Not Allowed) error and the Last-Modified: timestamp response header.

The following actions are related to HeadObject:

" + "documentation":"

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.

A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic code, such as 400 Bad Request, 403 Forbidden, 404 Not Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. It's not possible to retrieve the exact exception of these error codes.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - To use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys for Amazon S3 in the Amazon S3 User Guide.

    If the object you request doesn't exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

    • If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found error.

    • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a HEAD request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

Directory bucket permissions - For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
Versioning

  • If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

  • If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

  • Directory buckets - Delete marker is not supported by directory buckets.

  • Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following actions are related to HeadObject:

" }, "ListBucketAnalyticsConfigurations":{ "name":"ListBucketAnalyticsConfigurations", @@ -650,7 +782,10 @@ }, "input":{"shape":"ListBucketAnalyticsConfigurationsRequest"}, "output":{"shape":"ListBucketAnalyticsConfigurationsOutput"}, - "documentation":"

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to ListBucketAnalyticsConfigurations:

" + "documentation":"

This operation is not supported by directory buckets.

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to ListBucketAnalyticsConfigurations:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "ListBucketIntelligentTieringConfigurations":{ "name":"ListBucketIntelligentTieringConfigurations", @@ -660,7 +795,10 @@ }, "input":{"shape":"ListBucketIntelligentTieringConfigurationsRequest"}, "output":{"shape":"ListBucketIntelligentTieringConfigurationsOutput"}, - "documentation":"

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to ListBucketIntelligentTieringConfigurations include:

" + "documentation":"

This operation is not supported by directory buckets.

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to ListBucketIntelligentTieringConfigurations include:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "ListBucketInventoryConfigurations":{ "name":"ListBucketInventoryConfigurations", @@ -670,7 +808,10 @@ }, "input":{"shape":"ListBucketInventoryConfigurationsRequest"}, "output":{"shape":"ListBucketInventoryConfigurationsOutput"}, - "documentation":"

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory

The following operations are related to ListBucketInventoryConfigurations:

" + "documentation":"

This operation is not supported by directory buckets.

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory

The following operations are related to ListBucketInventoryConfigurations:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "ListBucketMetricsConfigurations":{ "name":"ListBucketMetricsConfigurations", @@ -680,7 +821,7 @@ }, "input":{"shape":"ListBucketMetricsConfigurationsRequest"}, "output":{"shape":"ListBucketMetricsConfigurationsOutput"}, - "documentation":"

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

" + "documentation":"

This operation is not supported by directory buckets.

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

" }, "ListBuckets":{ "name":"ListBuckets", @@ -690,9 +831,22 @@ }, "output":{"shape":"ListBucketsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html", - "documentation":"

Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the s3:ListAllMyBuckets permission.

For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets.

", + "documentation":"

This operation is not supported by directory buckets.

Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the s3:ListAllMyBuckets permission.

For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets.

", "alias":"GetService" }, + "ListDirectoryBuckets":{ + "name":"ListDirectoryBuckets", + "http":{ + "method":"GET", + "requestUri":"/" + }, + "input":{"shape":"ListDirectoryBucketsRequest"}, + "output":{"shape":"ListDirectoryBucketsOutput"}, + "documentation":"

Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

You must have the s3express:ListAllMyDirectoryBuckets permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } + }, "ListMultipartUploads":{ "name":"ListMultipartUploads", "http":{ @@ -702,7 +856,7 @@ "input":{"shape":"ListMultipartUploadsRequest"}, "output":{"shape":"ListMultipartUploadsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html", - "documentation":"

This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.

This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters.

In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions.

The following operations are related to ListMultipartUploads:

" + "documentation":"

This operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a multipart upload that has been initiated by the CreateMultipartUpload request, but has not yet been completed or aborted.

Directory buckets - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.

The ListMultipartUploads operation returns a maximum of 1,000 multipart uploads in the response. The limit of 1,000 multipart uploads is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads request parameter. If there are more than 1,000 multipart uploads that satisfy your ListMultipartUploads request, the response returns an IsTruncated element with the value of true, a NextKeyMarker element, and a NextUploadIdMarker element. To list the remaining multipart uploads, you need to make subsequent ListMultipartUploads requests. In these requests, include two query parameters: key-marker and upload-id-marker. Set the value of key-marker to the NextKeyMarker value from the previous response. Similarly, set the value of upload-id-marker to the NextUploadIdMarker value from the previous response.

Directory buckets - The upload-id-marker element and the NextUploadIdMarker element aren't supported by directory buckets. To list the additional multipart uploads, you only need to set the value of key-marker to the NextKeyMarker value from the previous response.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Sorting of multipart uploads in response

  • General purpose bucket - In the ListMultipartUploads response, the multipart uploads are sorted based on two criteria:

    • Key-based sorting - Multipart uploads are initially sorted in ascending order based on their object keys.

    • Time-based sorting - For uploads that share the same object key, they are further sorted in ascending order based on the upload initiation time. Among uploads with the same key, the one that was initiated first will appear before the ones that were initiated later.

  • Directory bucket - In the ListMultipartUploads response, the multipart uploads aren't sorted lexicographically based on the object keys.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to ListMultipartUploads:

" }, "ListObjectVersions":{ "name":"ListObjectVersions", @@ -713,7 +867,7 @@ "input":{"shape":"ListObjectVersionsRequest"}, "output":{"shape":"ListObjectVersionsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html", - "documentation":"

Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be aware of the name difference.

A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

The following operations are related to ListObjectVersions:

", + "documentation":"

This operation is not supported by directory buckets.

Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be aware of the name difference.

A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

The following operations are related to ListObjectVersions:

", "alias":"GetBucketObjectVersions" }, "ListObjects":{ @@ -728,7 +882,7 @@ {"shape":"NoSuchBucket"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html", - "documentation":"

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.

This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.

The following operations are related to ListObjects:

", + "documentation":"

This operation is not supported by directory buckets.

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.

This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.

The following operations are related to ListObjects:

", "alias":"GetBucket" }, "ListObjectsV2":{ @@ -742,7 +896,7 @@ "errors":[ {"shape":"NoSuchBucket"} ], - "documentation":"

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide.

To use this operation, you must have READ access to the bucket.

To use this action in an Identity and Access Management (IAM) policy, you must have permission to perform the s3:ListBucket action. The 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 in the Amazon S3 User Guide.

This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, ListObjects.

To get a list of your buckets, see ListBuckets.

The following operations are related to ListObjectsV2:

" + "documentation":"

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide. To get a list of your buckets, see ListBuckets.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - To use this operation, you must have READ access to the bucket. You must have permission to perform the s3:ListBucket action. The 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 in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Sorting order of returned objects

  • General purpose bucket - For general purpose buckets, ListObjectsV2 returns objects in lexicographical order based on their key names.

  • Directory bucket - For directory buckets, ListObjectsV2 does not return objects in lexicographical order.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, ListObjects.

The following operations are related to ListObjectsV2:

" }, "ListParts":{ "name":"ListParts", @@ -753,7 +907,7 @@ "input":{"shape":"ListPartsRequest"}, "output":{"shape":"ListPartsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html", - "documentation":"

Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

If the upload was created using a checksum algorithm, you will need to have permission to the kms:Decrypt action for the request to succeed.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions.

The following operations are related to ListParts:

" + "documentation":"

Lists the parts that have been uploaded for a specific multipart upload.

To use this operation, you must provide the upload ID in the request. You obtain this uploadID by sending the initiate multipart upload request through CreateMultipartUpload.

The ListParts request returns a maximum of 1,000 uploaded parts. The limit of 1,000 parts is also the default value. You can restrict the number of parts in a response by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. To list remaining uploaded parts, in subsequent ListParts requests, include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

    If the upload was created using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), you must have permission to the kms:Decrypt action for the ListParts request to succeed.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to ListParts:

" }, "PutBucketAccelerateConfiguration":{ "name":"PutBucketAccelerateConfiguration", @@ -762,10 +916,13 @@ "requestUri":"/{Bucket}?accelerate" }, "input":{"shape":"PutBucketAccelerateConfigurationRequest"}, - "documentation":"

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.

To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

The Transfer Acceleration state of a bucket can be set to one of the following two values:

  • Enabled – Enables accelerated data transfers to the bucket.

  • Suspended – Disables accelerated data transfers to the bucket.

The GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (\".\").

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to PutBucketAccelerateConfiguration:

", + "documentation":"

This operation is not supported by directory buckets.

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.

To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

The Transfer Acceleration state of a bucket can be set to one of the following two values:

  • Enabled – Enables accelerated data transfers to the bucket.

  • Suspended – Disables accelerated data transfers to the bucket.

The GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (\".\").

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to PutBucketAccelerateConfiguration:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":false + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketAcl":{ @@ -776,10 +933,13 @@ }, "input":{"shape":"PutBucketAclRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html", - "documentation":"

Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.

You can use one of the following two ways to set a bucket's permissions:

  • Specify the ACL in the request body

  • Specify permissions using request headers

You cannot specify access permission using both the body and the request headers.

Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.
Permissions

You can set access permissions by using one of the following methods:

  • Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.

    x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\", id=\"555566667777\"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

  • By the person's ID:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>

    DisplayName is optional and ignored in the request

  • By URI:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>

  • By Email address:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee>

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

The following operations are related to PutBucketAcl:

", + "documentation":"

This operation is not supported by directory buckets.

Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have the WRITE_ACP permission.

You can use one of the following two ways to set a bucket's permissions:

  • Specify the ACL in the request body

  • Specify permissions using request headers

You cannot specify access permission using both the body and the request headers.

Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.
Permissions

You can set access permissions by using one of the following methods:

  • Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.

    x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\", id=\"555566667777\"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

  • By the person's ID:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>

    DisplayName is optional and ignored in the request

  • By URI:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>

  • By Email address:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee>

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

The following operations are related to PutBucketAcl:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketAnalyticsConfiguration":{ @@ -789,7 +949,10 @@ "requestUri":"/{Bucket}?analytics" }, "input":{"shape":"PutBucketAnalyticsConfigurationRequest"}, - "documentation":"

Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.

You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.

You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

PutBucketAnalyticsConfiguration has the following special errors:

    • HTTP Error: HTTP 400 Bad Request

    • Code: InvalidArgument

    • Cause: Invalid argument.

    • HTTP Error: HTTP 400 Bad Request

    • Code: TooManyConfigurations

    • Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

    • HTTP Error: HTTP 403 Forbidden

    • Code: AccessDenied

    • Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.

The following operations are related to PutBucketAnalyticsConfiguration:

" + "documentation":"

This operation is not supported by directory buckets.

Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.

You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.

You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

PutBucketAnalyticsConfiguration has the following special errors:

    • HTTP Error: HTTP 400 Bad Request

    • Code: InvalidArgument

    • Cause: Invalid argument.

    • HTTP Error: HTTP 400 Bad Request

    • Code: TooManyConfigurations

    • Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

    • HTTP Error: HTTP 403 Forbidden

    • Code: AccessDenied

    • Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.

The following operations are related to PutBucketAnalyticsConfiguration:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "PutBucketCors":{ "name":"PutBucketCors", @@ -799,10 +962,13 @@ }, "input":{"shape":"PutBucketCorsRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html", - "documentation":"

Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

  • The request's Origin header must match AllowedOrigin elements.

  • The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements.

  • Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element.

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

The following operations are related to PutBucketCors:

", + "documentation":"

This operation is not supported by directory buckets.

Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

  • The request's Origin header must match AllowedOrigin elements.

  • The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements.

  • Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element.

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

The following operations are related to PutBucketCors:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketEncryption":{ @@ -812,10 +978,13 @@ "requestUri":"/{Bucket}?encryption" }, "input":{"shape":"PutBucketEncryptionRequest"}, - "documentation":"

This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Keys for an existing bucket.

By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also configure Amazon S3 Bucket Keys. If you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 does not validate the KMS key ID provided in PutBucketEncryption requests.

This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).

To use this operation, you must have permission to perform the s3:PutEncryptionConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

The following operations are related to PutBucketEncryption:

", + "documentation":"

This operation is not supported by directory buckets.

This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Keys for an existing bucket.

By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also configure Amazon S3 Bucket Keys. If you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 does not validate the KMS key ID provided in PutBucketEncryption requests.

This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).

To use this operation, you must have permission to perform the s3:PutEncryptionConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

The following operations are related to PutBucketEncryption:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketIntelligentTieringConfiguration":{ @@ -825,7 +994,10 @@ "requestUri":"/{Bucket}?intelligent-tiering" }, "input":{"shape":"PutBucketIntelligentTieringConfigurationRequest"}, - "documentation":"

Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to PutBucketIntelligentTieringConfiguration include:

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.

PutBucketIntelligentTieringConfiguration has the following special errors:

HTTP 400 Bad Request Error

Code: InvalidArgument

Cause: Invalid Argument

HTTP 400 Bad Request Error

Code: TooManyConfigurations

Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

HTTP 403 Forbidden Error

Cause: You are not the owner of the specified bucket, or you do not have the s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket.

" + "documentation":"

This operation is not supported by directory buckets.

Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to PutBucketIntelligentTieringConfiguration include:

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.

PutBucketIntelligentTieringConfiguration has the following special errors:

HTTP 400 Bad Request Error

Code: InvalidArgument

Cause: Invalid Argument

HTTP 400 Bad Request Error

Code: TooManyConfigurations

Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

HTTP 403 Forbidden Error

Cause: You are not the owner of the specified bucket, or you do not have the s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket.

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "PutBucketInventoryConfiguration":{ "name":"PutBucketInventoryConfiguration", @@ -834,7 +1006,10 @@ "requestUri":"/{Bucket}?inventory" }, "input":{"shape":"PutBucketInventoryConfigurationRequest"}, - "documentation":"

This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.

You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
Permissions

To use this operation, you must have permission to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others.

The s3:PutInventoryConfiguration permission allows a user to create an S3 Inventory report that includes all object metadata fields available and to specify the destination bucket to store the inventory. A user with read access to objects in the destination bucket can also access all object metadata fields that are available in the inventory report.

To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more information about the metadata fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the Amazon S3 User Guide.

PutBucketInventoryConfiguration has the following special errors:

HTTP 400 Bad Request Error

Code: InvalidArgument

Cause: Invalid Argument

HTTP 400 Bad Request Error

Code: TooManyConfigurations

Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

HTTP 403 Forbidden Error

Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.

The following operations are related to PutBucketInventoryConfiguration:

" + "documentation":"

This operation is not supported by directory buckets.

This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.

You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
Permissions

To use this operation, you must have permission to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others.

The s3:PutInventoryConfiguration permission allows a user to create an S3 Inventory report that includes all object metadata fields available and to specify the destination bucket to store the inventory. A user with read access to objects in the destination bucket can also access all object metadata fields that are available in the inventory report.

To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more information about the metadata fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the Amazon S3 User Guide.

PutBucketInventoryConfiguration has the following special errors:

HTTP 400 Bad Request Error

Code: InvalidArgument

Cause: Invalid Argument

HTTP 400 Bad Request Error

Code: TooManyConfigurations

Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

HTTP 403 Forbidden Error

Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.

The following operations are related to PutBucketInventoryConfiguration:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "PutBucketLifecycle":{ "name":"PutBucketLifecycle", @@ -844,11 +1019,14 @@ }, "input":{"shape":"PutBucketLifecycleRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html", - "documentation":"

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide.

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

  • s3:DeleteObject

  • s3:DeleteObjectVersion

  • s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.

The following operations are related to PutBucketLifecycle:

", + "documentation":"

This operation is not supported by directory buckets.

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide.

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

  • s3:DeleteObject

  • s3:DeleteObjectVersion

  • s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.

The following operations are related to PutBucketLifecycle:

", "deprecated":true, "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketLifecycleConfiguration":{ @@ -858,10 +1036,13 @@ "requestUri":"/{Bucket}?lifecycle" }, "input":{"shape":"PutBucketLifecycleConfigurationRequest"}, - "documentation":"

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
Rules

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following:

  • A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.

  • A status indicating whether the rule is in effect.

  • One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.

For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.

Permissions

By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

  • s3:DeleteObject

  • s3:DeleteObjectVersion

  • s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to PutBucketLifecycleConfiguration:

", + "documentation":"

This operation is not supported by directory buckets.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
Rules

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following:

  • A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.

  • A status indicating whether the rule is in effect.

  • One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.

For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.

Permissions

By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

  • s3:DeleteObject

  • s3:DeleteObjectVersion

  • s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to PutBucketLifecycleConfiguration:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketLogging":{ @@ -872,10 +1053,13 @@ }, "input":{"shape":"PutBucketLoggingRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html", - "documentation":"

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.

If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can't use the Grantee request element to grant access to others. Permissions can only be granted using policies. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.
Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (by using request elements) in the following ways:

  • By the person's ID:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>

    DisplayName is optional and ignored in the request.

  • By Email address:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>

    The grantee is resolved to the CanonicalUser and, in a response to a GETObjectAcl request, appears as the CanonicalUser.

  • By URI:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>

To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:

<BucketLoggingStatus xmlns=\"http://doc.s3.amazonaws.com/2006-03-01\" />

For more information about server access logging, see Server Access Logging in the Amazon S3 User Guide.

For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.

The following operations are related to PutBucketLogging:

", + "documentation":"

This operation is not supported by directory buckets.

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.

If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can't use the Grantee request element to grant access to others. Permissions can only be granted using policies. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.
Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (by using request elements) in the following ways:

  • By the person's ID:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>

    DisplayName is optional and ignored in the request.

  • By Email address:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>

    The grantee is resolved to the CanonicalUser and, in a response to a GETObjectAcl request, appears as the CanonicalUser.

  • By URI:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>

To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:

<BucketLoggingStatus xmlns=\"http://doc.s3.amazonaws.com/2006-03-01\" />

For more information about server access logging, see Server Access Logging in the Amazon S3 User Guide.

For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.

The following operations are related to PutBucketLogging:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketMetricsConfiguration":{ @@ -885,7 +1069,10 @@ "requestUri":"/{Bucket}?metrics" }, "input":{"shape":"PutBucketMetricsConfigurationRequest"}, - "documentation":"

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to PutBucketMetricsConfiguration:

PutBucketMetricsConfiguration has the following special error:

  • Error code: TooManyConfigurations

    • Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

    • HTTP Status Code: HTTP 400 Bad Request

" + "documentation":"

This operation is not supported by directory buckets.

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to PutBucketMetricsConfiguration:

PutBucketMetricsConfiguration has the following special error:

  • Error code: TooManyConfigurations

    • Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

    • HTTP Status Code: HTTP 400 Bad Request

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "PutBucketNotification":{ "name":"PutBucketNotification", @@ -895,11 +1082,14 @@ }, "input":{"shape":"PutBucketNotificationRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html", - "documentation":"

No longer used, see the PutBucketNotificationConfiguration operation.

", + "documentation":"

This operation is not supported by directory buckets.

No longer used, see the PutBucketNotificationConfiguration operation.

", "deprecated":true, "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketNotificationConfiguration":{ @@ -909,7 +1099,10 @@ "requestUri":"/{Bucket}?notification" }, "input":{"shape":"PutBucketNotificationConfigurationRequest"}, - "documentation":"

Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.

Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.

By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.

<NotificationConfiguration>

</NotificationConfiguration>

This action replaces the existing notification configuration with the configuration you include in the request body.

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.

You can disable notifications by adding the empty NotificationConfiguration element.

For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference.

By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with the required s3:PutBucketNotification permission.

The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.

If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic.

The following action is related to PutBucketNotificationConfiguration:

" + "documentation":"

This operation is not supported by directory buckets.

Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.

Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.

By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.

<NotificationConfiguration>

</NotificationConfiguration>

This action replaces the existing notification configuration with the configuration you include in the request body.

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.

You can disable notifications by adding the empty NotificationConfiguration element.

For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference.

By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with the required s3:PutBucketNotification permission.

The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.

If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic.

The following action is related to PutBucketNotificationConfiguration:

", + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "PutBucketOwnershipControls":{ "name":"PutBucketOwnershipControls", @@ -918,8 +1111,11 @@ "requestUri":"/{Bucket}?ownershipControls" }, "input":{"shape":"PutBucketOwnershipControlsRequest"}, - "documentation":"

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using object ownership.

The following operations are related to PutBucketOwnershipControls:

", - "httpChecksum":{"requestChecksumRequired":true} + "documentation":"

This operation is not supported by directory buckets.

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using object ownership.

The following operations are related to PutBucketOwnershipControls:

", + "httpChecksum":{"requestChecksumRequired":true}, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} + } }, "PutBucketPolicy":{ "name":"PutBucketPolicy", @@ -929,10 +1125,13 @@ }, "input":{"shape":"PutBucketPolicyRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html", - "documentation":"

Applies an Amazon S3 bucket policy to an Amazon S3 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 PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

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.

To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

For more information, see Bucket policy examples.

The following operations are related to PutBucketPolicy:

", + "documentation":"

Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

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 both have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

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.

To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

  • General purpose bucket permissions - The s3:PutBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

Example bucket policies

General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.

Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to PutBucketPolicy:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketReplication":{ @@ -942,10 +1141,13 @@ "requestUri":"/{Bucket}?replication" }, "input":{"shape":"PutBucketReplicationRequest"}, - "documentation":"

Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information. You can invoke this request for a specific Amazon Web Services Region by using the aws:RequestedRegion condition key.

A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source 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 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.

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

For information about enabling versioning on a bucket, see Using Versioning.

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using KMS keys.

For information on PutBucketReplication errors, see List of replication-related error codes

Permissions

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration permissions for the bucket.

By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.

To perform this operation, the user or role performing the action must have the iam:PassRole permission.

The following operations are related to PutBucketReplication:

", + "documentation":"

This operation is not supported by directory buckets.

Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information. You can invoke this request for a specific Amazon Web Services Region by using the aws:RequestedRegion condition key.

A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source 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 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.

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

For information about enabling versioning on a bucket, see Using Versioning.

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using KMS keys.

For information on PutBucketReplication errors, see List of replication-related error codes

Permissions

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration permissions for the bucket.

By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.

To perform this operation, the user or role performing the action must have the iam:PassRole permission.

The following operations are related to PutBucketReplication:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketRequestPayment":{ @@ -956,10 +1158,13 @@ }, "input":{"shape":"PutBucketRequestPaymentRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html", - "documentation":"

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

", + "documentation":"

This operation is not supported by directory buckets.

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketTagging":{ @@ -970,10 +1175,13 @@ }, "input":{"shape":"PutBucketTaggingRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html", - "documentation":"

Sets the tags for a bucket.

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 and Using Cost Allocation in Amazon S3 Bucket Tags.

When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.

To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The 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. For more Amazon S3 errors see, Error Responses.

  • InvalidTag - The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.

  • MalformedXML - The XML provided does not match the schema.

  • OperationAborted - A conflicting conditional action is currently in progress against this resource. Please try again.

  • InternalError - The service was unable to apply the provided tag to the bucket.

The following operations are related to PutBucketTagging:

", + "documentation":"

This operation is not supported by directory buckets.

Sets the tags for a bucket.

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 and Using Cost Allocation in Amazon S3 Bucket Tags.

When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.

To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The 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. For more Amazon S3 errors see, Error Responses.

  • InvalidTag - The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.

  • MalformedXML - The XML provided does not match the schema.

  • OperationAborted - A conflicting conditional action is currently in progress against this resource. Please try again.

  • InternalError - The service was unable to apply the provided tag to the bucket.

The following operations are related to PutBucketTagging:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketVersioning":{ @@ -984,10 +1192,13 @@ }, "input":{"shape":"PutBucketVersioningRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html", - "documentation":"

Sets the versioning state of an existing bucket.

You can set the versioning state with one of the following values:

Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.

If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.

In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket.

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. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.

The following operations are related to PutBucketVersioning:

", + "documentation":"

This operation is not supported by directory buckets.

Sets the versioning state of an existing bucket.

You can set the versioning state with one of the following values:

Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.

If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.

In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket.

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. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.

The following operations are related to PutBucketVersioning:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutBucketWebsite":{ @@ -998,10 +1209,13 @@ }, "input":{"shape":"PutBucketWebsiteRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html", - "documentation":"

Sets the configuration of the website that is specified in the website subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3.

This PUT action requires the S3:PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite permission.

To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.

  • WebsiteConfiguration

  • RedirectAllRequestsTo

  • HostName

  • Protocol

If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.

  • WebsiteConfiguration

  • IndexDocument

  • Suffix

  • ErrorDocument

  • Key

  • RoutingRules

  • RoutingRule

  • Condition

  • HttpErrorCodeReturnedEquals

  • KeyPrefixEquals

  • Redirect

  • Protocol

  • HostName

  • ReplaceKeyPrefixWith

  • ReplaceKeyWith

  • HttpRedirectCode

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon S3 User Guide.

The maximum request length is limited to 128 KB.

", + "documentation":"

This operation is not supported by directory buckets.

Sets the configuration of the website that is specified in the website subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3.

This PUT action requires the S3:PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite permission.

To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.

  • WebsiteConfiguration

  • RedirectAllRequestsTo

  • HostName

  • Protocol

If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.

  • WebsiteConfiguration

  • IndexDocument

  • Suffix

  • ErrorDocument

  • Key

  • RoutingRules

  • RoutingRule

  • Condition

  • HttpErrorCodeReturnedEquals

  • KeyPrefixEquals

  • Redirect

  • Protocol

  • HostName

  • ReplaceKeyPrefixWith

  • ReplaceKeyWith

  • HttpRedirectCode

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon S3 User Guide.

The maximum request length is limited to 128 KB.

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "PutObject":{ @@ -1013,7 +1227,7 @@ "input":{"shape":"PutObjectRequest"}, "output":{"shape":"PutObjectOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html", - "documentation":"

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. You cannot use PutObject to only update a single piece of metadata for an existing object. You must put the entire object with updated metadata if you want to update some values.

Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. To prevent objects from being deleted or overwritten, you can use Amazon S3 Object Lock.

To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

  • To successfully complete the PutObject request, you must have the s3:PutObject in your IAM permissions.

  • To successfully change the objects acl of your PutObject request, you must have the s3:PutObjectAcl in your IAM permissions.

  • To successfully set the tag-set with your PutObject request, you must have the s3:PutObjectTagging in your IAM permissions.

  • The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide.

You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption.

When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a 400 error with the error code AccessControlListNotSupported. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning.

For more information about related Amazon S3 APIs, see the following:

", + "documentation":"

Adds an object to a bucket.

  • Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. You cannot use PutObject to only update a single piece of metadata for an existing object. You must put the entire object with updated metadata if you want to update some values.

  • If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All objects written to the bucket by any account will be owned by the bucket owner.

  • Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:

  • S3 Object Lock - To prevent objects from being deleted or overwritten, you can use Amazon S3 Object Lock in the Amazon S3 User Guide.

    This functionality is not supported for directory buckets.

  • S3 Versioning - When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all versions of the objects. For each write request that is made to the same object, Amazon S3 automatically generates a unique version ID of that object being stored in Amazon S3. You can retrieve, replace, or delete any version of the object. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.

    This functionality is not supported for directory buckets.
Permissions

  • General purpose bucket permissions - The following permissions are required in your policies when your PutObject request includes specific headers.

    • s3:PutObject - To successfully complete the PutObject request, you must always have the s3:PutObject permission on a bucket to add an object to it.

    • s3:PutObjectAcl - To successfully change the objects ACL of your PutObject request, you must have the s3:PutObjectAcl.

    • s3:PutObjectTagging - To successfully set the tag-set with your PutObject request, you must have the s3:PutObjectTagging.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Data integrity with Content-MD5

  • General purpose bucket - To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest, you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

  • Directory bucket - This functionality is not supported for directory buckets.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

For more information about related Amazon S3 APIs, see the following:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":false @@ -1031,7 +1245,7 @@ {"shape":"NoSuchKey"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html", - "documentation":"

Uses the acl subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have WRITE_ACP permission to set the ACL of an object. For more information, see What permissions can I grant? in the Amazon S3 User Guide.

This action is not supported by Amazon S3 on Outposts.

Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.
Permissions

You can set access permissions using one of the following methods:

  • Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-read header grants list objects permission to the two Amazon Web Services accounts identified by their email addresses.

    x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

  • By the person's ID:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>

    DisplayName is optional and ignored in the request.

  • By URI:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>

  • By Email address:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
Versioning

The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource.

The following operations are related to PutObjectAcl:

", + "documentation":"

This operation is not supported by directory buckets.

Uses the acl subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have the WRITE_ACP permission to set the ACL of an object. For more information, see What permissions can I grant? in the Amazon S3 User Guide.

This functionality is not supported for Amazon S3 on Outposts.

Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.
Permissions

You can set access permissions using one of the following methods:

  • Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-read header grants list objects permission to the two Amazon Web Services accounts identified by their email addresses.

    x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

  • By the person's ID:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>

    DisplayName is optional and ignored in the request.

  • By URI:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>

  • By Email address:

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
Versioning

The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource.

The following operations are related to PutObjectAcl:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true @@ -1045,7 +1259,7 @@ }, "input":{"shape":"PutObjectLegalHoldRequest"}, "output":{"shape":"PutObjectLegalHoldOutput"}, - "documentation":"

Applies a legal hold configuration to the specified object. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

This operation is not supported by directory buckets.

Applies a legal hold configuration to the specified object. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true @@ -1059,7 +1273,7 @@ }, "input":{"shape":"PutObjectLockConfigurationRequest"}, "output":{"shape":"PutObjectLockConfigurationOutput"}, - "documentation":"

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

  • The DefaultRetention settings require both a mode and a period.

  • The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

  • You can enable Object Lock for new or existing buckets. For more information, see Configuring Object Lock.

", + "documentation":"

This operation is not supported by directory buckets.

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

  • The DefaultRetention settings require both a mode and a period.

  • The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

  • You can enable Object Lock for new or existing buckets. For more information, see Configuring Object Lock.

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true @@ -1073,7 +1287,7 @@ }, "input":{"shape":"PutObjectRetentionRequest"}, "output":{"shape":"PutObjectRetentionOutput"}, - "documentation":"

Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

This operation is not supported by directory buckets.

Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission.

This functionality is not supported for Amazon S3 on Outposts.

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true @@ -1087,7 +1301,7 @@ }, "input":{"shape":"PutObjectTaggingRequest"}, "output":{"shape":"PutObjectTaggingOutput"}, - "documentation":"

Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. For more information, see Object Tagging.

You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.

For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others.

To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.

PutObjectTagging has the following special errors. For more Amazon S3 errors see, Error Responses.

  • InvalidTag - The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging.

  • MalformedXML - The XML provided does not match the schema.

  • OperationAborted - A conflicting conditional action is currently in progress against this resource. Please try again.

  • InternalError - The service was unable to apply the provided tag to the object.

The following operations are related to PutObjectTagging:

", + "documentation":"

This operation is not supported by directory buckets.

Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. For more information, see Object Tagging.

You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.

For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others.

To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.

PutObjectTagging has the following special errors. For more Amazon S3 errors see, Error Responses.

  • InvalidTag - The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging.

  • MalformedXML - The XML provided does not match the schema.

  • OperationAborted - A conflicting conditional action is currently in progress against this resource. Please try again.

  • InternalError - The service was unable to apply the provided tag to the object.

The following operations are related to PutObjectTagging:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true @@ -1100,10 +1314,13 @@ "requestUri":"/{Bucket}?publicAccessBlock" }, "input":{"shape":"PutPublicAccessBlockRequest"}, - "documentation":"

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

The following operations are related to PutPublicAccessBlock:

", + "documentation":"

This operation is not supported by directory buckets.

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

The following operations are related to PutPublicAccessBlock:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true + }, + "staticContextParams":{ + "UseS3ExpressControlEndpoint":{"value":true} } }, "RestoreObject":{ @@ -1118,7 +1335,7 @@ {"shape":"ObjectAlreadyInActiveTierError"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html", - "documentation":"

Restores an archived copy of an object back into Amazon S3

This action is not supported by Amazon S3 on Outposts.

This action performs the following types of requests:

  • select - Perform a select query on an archived object

  • restore an archive - Restore an archived object

For more information about the S3 structure in the request body, see the following:

Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples.

  • The following expression returns all records from the specified object.

    SELECT * FROM Object

  • Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.

    SELECT s._1, s._2 FROM Object s WHERE s._3 > 100

  • If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names.

    SELECT s.Id, s.FirstName, s.SSN FROM S3Object s

When making a select request, you can also do the following:

  • To expedite your queries, specify the Expedited tier. For more information about tiers, see \"Restoring Archives,\" later in this topic.

  • Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.

The following are additional important facts about the select feature:

  • The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle configuration.

  • You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't duplicate requests, so avoid issuing duplicate requests.

  • Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409.

Permissions

To use this operation, you must have permissions to perform the s3:RestoreObject action. The 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 in the Amazon S3 User Guide.

Restoring objects

Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage classes, you must first initiate a restore request, and then wait until a temporary copy of the object is available. If you want a permanent copy of the object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must restore the object for the duration (number of days) that you specify. For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier.

To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.

When restoring an archived object, you can specify one of the following data access tier options in the Tier element of the request body:

  • Expedited - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.

  • Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

  • Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.

For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.

To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon S3 User Guide.

After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.

If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User Guide.

Responses

A successful action returns either the 200 OK or 202 Accepted status code.

  • If the object is not previously restored, then Amazon S3 returns 202 Accepted in the response.

  • If the object is previously restored, Amazon S3 returns 200 OK in the response.

  • Special errors:

    • Code: RestoreAlreadyInProgress

    • Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)

    • HTTP Status Code: 409 Conflict

    • SOAP Fault Code Prefix: Client

    • Code: GlacierExpeditedRetrievalNotAvailable

    • Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)

    • HTTP Status Code: 503

    • SOAP Fault Code Prefix: N/A

The following operations are related to RestoreObject:

", + "documentation":"

This operation is not supported by directory buckets.

Restores an archived copy of an object back into Amazon S3

This functionality is not supported for Amazon S3 on Outposts.

This action performs the following types of requests:

  • select - Perform a select query on an archived object

  • restore an archive - Restore an archived object

For more information about the S3 structure in the request body, see the following:

Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples.

  • The following expression returns all records from the specified object.

    SELECT * FROM Object

  • Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.

    SELECT s._1, s._2 FROM Object s WHERE s._3 > 100

  • If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names.

    SELECT s.Id, s.FirstName, s.SSN FROM S3Object s

When making a select request, you can also do the following:

  • To expedite your queries, specify the Expedited tier. For more information about tiers, see \"Restoring Archives,\" later in this topic.

  • Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.

The following are additional important facts about the select feature:

  • The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle configuration.

  • You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't duplicate requests, so avoid issuing duplicate requests.

  • Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409.

Permissions

To use this operation, you must have permissions to perform the s3:RestoreObject action. The 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 in the Amazon S3 User Guide.

Restoring objects

Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage classes, you must first initiate a restore request, and then wait until a temporary copy of the object is available. If you want a permanent copy of the object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must restore the object for the duration (number of days) that you specify. For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier.

To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.

When restoring an archived object, you can specify one of the following data access tier options in the Tier element of the request body:

  • Expedited - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.

  • Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

  • Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.

For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.

To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon S3 User Guide.

After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.

If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User Guide.

Responses

A successful action returns either the 200 OK or 202 Accepted status code.

  • If the object is not previously restored, then Amazon S3 returns 202 Accepted in the response.

  • If the object is previously restored, Amazon S3 returns 200 OK in the response.

  • Special errors:

    • Code: RestoreAlreadyInProgress

    • Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)

    • HTTP Status Code: 409 Conflict

    • SOAP Fault Code Prefix: Client

    • Code: GlacierExpeditedRetrievalNotAvailable

    • Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)

    • HTTP Status Code: 503

    • SOAP Fault Code Prefix: N/A

The following operations are related to RestoreObject:

", "alias":"PostObjectRestore", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", @@ -1137,7 +1354,7 @@ "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, "output":{"shape":"SelectObjectContentOutput"}, - "documentation":"

This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

This action is not supported by Amazon S3 on Outposts.

For more information about Amazon S3 Select, see Selecting Content from Objects and SELECT Command in the Amazon S3 User Guide.

Permissions

You must have s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon S3 User Guide.

Object Data Formats

You can use Amazon S3 Select to query objects that have the following format properties:

  • CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.

  • UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.

  • GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.

  • Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

    For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide.

Working with the Response Body

Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see Appendix: SelectObjectContent Response.

GetObject Support

The SelectObjectContent action does not support the following GetObject functionality. For more information, see GetObject.

  • Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify the range of bytes of an object to return.

  • The GLACIER, DEEP_ARCHIVE, and REDUCED_REDUNDANCY storage classes, or the ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class: You cannot query objects in the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes, nor objects in the ARCHIVE_ACCESS or DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class. For more information about storage classes, see Using Amazon S3 storage classes in the Amazon S3 User Guide.

Special Errors

For a list of special errors for this operation, see List of SELECT Object Content Error Codes

The following operations are related to SelectObjectContent:

" + "documentation":"

This operation is not supported by directory buckets.

This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

This functionality is not supported for Amazon S3 on Outposts.

For more information about Amazon S3 Select, see Selecting Content from Objects and SELECT Command in the Amazon S3 User Guide.

Permissions

You must have the s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon S3 User Guide.

Object Data Formats

You can use Amazon S3 Select to query objects that have the following format properties:

  • CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.

  • UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.

  • GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.

  • Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

    For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide.

Working with the Response Body

Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see Appendix: SelectObjectContent Response.

GetObject Support

The SelectObjectContent action does not support the following GetObject functionality. For more information, see GetObject.

  • Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify the range of bytes of an object to return.

  • The GLACIER, DEEP_ARCHIVE, and REDUCED_REDUNDANCY storage classes, or the ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class: You cannot query objects in the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes, nor objects in the ARCHIVE_ACCESS or DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class. For more information about storage classes, see Using Amazon S3 storage classes in the Amazon S3 User Guide.

Special Errors

For a list of special errors for this operation, see List of SELECT Object Content Error Codes

The following operations are related to SelectObjectContent:

" }, "UploadPart":{ "name":"UploadPart", @@ -1148,7 +1365,7 @@ "input":{"shape":"UploadPartRequest"}, "output":{"shape":"UploadPartOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html", - "documentation":"

Uploads a part in a multipart upload.

In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.

You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten.

For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.

To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error.

If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

For more information on multipart uploads, go to Multipart Upload Overview in the Amazon S3 User Guide .

For information on the permissions required to use the multipart upload API, go to Multipart Upload and Permissions in the Amazon S3 User Guide.

Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You have three mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption with other key options. The option you use depends on whether you want to use KMS keys (SSE-KMS) or provide your own encryption key (SSE-C). If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon S3 User Guide.

Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key (SSE-C), you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload.

If you requested server-side encryption using a customer-provided encryption key (SSE-C) in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

UploadPart has the following special errors:

    • Code: NoSuchUpload

    • Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • HTTP Status Code: 404 Not Found

    • SOAP Fault Code Prefix: Client

The following operations are related to UploadPart:

", + "documentation":"

Uploads a part in a multipart upload.

In this operation, you provide new data as a part of an object in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.

You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier that you must include in your upload part request.

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten.

For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.

After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

For more information on multipart uploads, go to Multipart Upload Overview in the Amazon S3 User Guide .

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - For information on the permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Data integrity

General purpose bucket - To ensure that data is not corrupted traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).

Directory buckets - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.
Encryption

  • General purpose bucket - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You have mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption with other key options. The option you use depends on whether you want to use KMS keys (SSE-KMS) or provide your own encryption key (SSE-C).

    Server-side encryption is supported by the S3 Multipart Upload operations. Unless you are using a customer-provided encryption key (SSE-C), you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload.

    If you request server-side encryption using a customer-provided encryption key (SSE-C) in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following request headers.

    • x-amz-server-side-encryption-customer-algorithm

    • x-amz-server-side-encryption-customer-key

    • x-amz-server-side-encryption-customer-key-MD5

  • Directory bucket - For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.

Special errors

  • Error Code: NoSuchUpload

    • Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • HTTP Status Code: 404 Not Found

    • SOAP Fault Code Prefix: Client

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to UploadPart:

", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":false @@ -1163,7 +1380,10 @@ "input":{"shape":"UploadPartCopyRequest"}, "output":{"shape":"UploadPartCopyOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html", - "documentation":"

Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request.

For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.

Instead of using an existing object as part data, you might use the UploadPart action and provide data in your request.

You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.

For more information about using the UploadPartCopy operation, see the following:

  • For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

  • For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide.

  • For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.

Note the following additional considerations about the request headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since:

  • Consideration 1 - If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows:

    x-amz-copy-source-if-match condition evaluates to true, and;

    x-amz-copy-source-if-unmodified-since condition evaluates to false;

    Amazon S3 returns 200 OK and copies the data.

  • Consideration 2 - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows:

    x-amz-copy-source-if-none-match condition evaluates to false, and;

    x-amz-copy-source-if-modified-since condition evaluates to true;

    Amazon S3 returns 412 Precondition Failed response code.

Versioning

If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source.

You can optionally specify a specific version of the source object to copy by adding the versionId subresource as shown in the following example:

x-amz-copy-source: /bucket/object?versionId=version id

Special errors

    • Code: NoSuchUpload

    • Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • HTTP Status Code: 404 Not Found

    • Code: InvalidRequest

    • Cause: The specified copy source is not supported as a byte-range copy source.

    • HTTP Status Code: 400 Bad Request

The following operations are related to UploadPartCopy:

" + "documentation":"

Uploads a part by copying data from an existing object as data source. To specify the data source, you add the request header x-amz-copy-source in your request. To specify a byte range, you add the request header x-amz-copy-source-range in your request.

For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.

Instead of copying data from an existing object as part data, you might use the UploadPart action to upload new data as a part of an object in your request.

You must initiate a multipart upload before you can upload any part. In response to your initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in your upload part request.

For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Authentication and authorization

All UploadPartCopy requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory buckets - You must use IAM credentials to authenticate and authorize your access to the UploadPartCopy API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

You must have READ access to the source object and WRITE access to the destination bucket.

  • General purpose bucket permissions - You must have the permissions in a policy based on the bucket types of your source bucket and destination bucket in an UploadPartCopy operation.

    • If the source object is in a general purpose bucket, you must have the s3:GetObject permission to read the source object that is being copied.

    • If the destination bucket is a general purpose bucket, you must have the s3:PubObject permission to write the object copy to the destination bucket.

    For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in an UploadPartCopy operation.

    • If the source object that you want to copy is in a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to read the object . By default, the session is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode condition key to ReadOnly on the copy source bucket.

    • If the copy destination is a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to write the object to the destination. The s3express:SessionMode condition key cannot be set to ReadOnly on the copy destination.

    For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

Encryption

  • General purpose buckets - For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.

  • Directory buckets - For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

Special errors

  • Error Code: NoSuchUpload

    • Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • HTTP Status Code: 404 Not Found

  • Error Code: InvalidRequest

    • Description: The specified copy source is not supported as a byte-range copy source.

    • HTTP Status Code: 400 Bad Request

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to UploadPartCopy:

", + "staticContextParams":{ + "DisableS3ExpressSessionAuth":{"value":true} + } }, "WriteGetObjectResponse":{ "name":"WriteGetObjectResponse", @@ -1172,7 +1392,7 @@ "requestUri":"/WriteGetObjectResponse" }, "input":{"shape":"WriteGetObjectResponseRequest"}, - "documentation":"

Passes transformed objects to a GetObject operation when using Object Lambda access points. For information about Object Lambda access points, see Transforming objects with Object Lambda access points in the Amazon S3 User Guide.

This operation supports metadata that can be returned by GetObject, in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The GetObject response metadata is supported so that the WriteGetObjectResponse caller, typically an Lambda function, can provide the same metadata when it internally invokes GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the metadata returned to the end user GetObject call might differ from what Amazon S3 would normally return.

You can include any number of metadata headers. When including a metadata header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject metadata.

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

", + "documentation":"

This operation is not supported by directory buckets.

Passes transformed objects to a GetObject operation when using Object Lambda access points. For information about Object Lambda access points, see Transforming objects with Object Lambda access points in the Amazon S3 User Guide.

This operation supports metadata that can be returned by GetObject, in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The GetObject response metadata is supported so that the WriteGetObjectResponse caller, typically an Lambda function, can provide the same metadata when it internally invokes GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the metadata returned to the end user GetObject call might differ from what Amazon S3 would normally return.

You can include any number of metadata headers. When including a metadata header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject metadata.

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

", "authtype":"v4-unsigned-body", "endpoint":{ "hostPrefix":"{RequestRoute}." @@ -1214,7 +1434,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name to which the upload was taking place.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The bucket name to which the upload was taking place.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -1239,7 +1459,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -1283,6 +1503,11 @@ }, "documentation":"

A container for information about access control for replicas.

" }, + "AccessKeyIdValue":{"type":"string"}, + "AccessPointAlias":{ + "type":"boolean", + "box":true + }, "AccessPointArn":{"type":"string"}, "AccountId":{"type":"string"}, "AllowQuotedRecordDelimiter":{ @@ -1430,7 +1655,7 @@ "documentation":"

Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.

" } }, - "documentation":"

In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally unique, and the namespace is shared by all Amazon Web Services accounts.

" + "documentation":"

In terms of implementation, a Bucket is a resource.

" }, "BucketAccelerateStatus":{ "type":"string", @@ -1444,6 +1669,7 @@ "members":{ }, "documentation":"

The requested bucket name is not available. The bucket namespace is shared by all users of the system. Select a different name and try again.

", + "error":{"httpStatusCode":409}, "exception":true }, "BucketAlreadyOwnedByYou":{ @@ -1451,6 +1677,7 @@ "members":{ }, "documentation":"

The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).

", + "error":{"httpStatusCode":409}, "exception":true }, "BucketCannedACL":{ @@ -1462,6 +1689,20 @@ "authenticated-read" ] }, + "BucketInfo":{ + "type":"structure", + "members":{ + "DataRedundancy":{ + "shape":"DataRedundancy", + "documentation":"

The number of Availability Zone that's used for redundancy for the bucket.

" + }, + "Type":{ + "shape":"BucketType", + "documentation":"

The type of bucket.

" + } + }, + "documentation":"

Specifies the information about the bucket that will be created. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.

" + }, "BucketKeyEnabled":{ "type":"boolean", "box":true @@ -1487,6 +1728,7 @@ "ap-northeast-2", "ap-northeast-3", "ap-south-1", + "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", @@ -1497,6 +1739,7 @@ "eu-central-1", "eu-north-1", "eu-south-1", + "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", @@ -1506,11 +1749,10 @@ "us-gov-east-1", "us-gov-west-1", "us-west-1", - "us-west-2", - "ap-south-2", - "eu-south-2" + "us-west-2" ] }, + "BucketLocationName":{"type":"string"}, "BucketLoggingStatus":{ "type":"structure", "members":{ @@ -1527,6 +1769,10 @@ ] }, "BucketName":{"type":"string"}, + "BucketType":{ + "type":"string", + "enum":["Directory"] + }, "BucketVersioningStatus":{ "type":"string", "enum":[ @@ -1678,19 +1924,19 @@ "members":{ "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" } }, "documentation":"

Contains all the possible checksum or digest values for an object.

" @@ -1769,7 +2015,7 @@ }, "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

" + "documentation":"

The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.

Access points are not supported by directory buckets.

" }, "Key":{ "shape":"ObjectKey", @@ -1777,7 +2023,7 @@ }, "Expiration":{ "shape":"Expiration", - "documentation":"

If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL-encoded.

", + "documentation":"

If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL-encoded.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-expiration" }, @@ -1787,41 +2033,41 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

", + "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

", "location":"header", "locationName":"x-amz-server-side-encryption" }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

Version ID of the newly created object, in case the bucket has versioning turned on.

", + "documentation":"

Version ID of the newly created object, in case the bucket has versioning turned on.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-version-id" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

", + "documentation":"

If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "BucketKeyEnabled":{ "shape":"BucketKeyEnabled", - "documentation":"

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

", + "documentation":"

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-bucket-key-enabled" }, @@ -1842,7 +2088,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

Name of the bucket to which the multipart upload was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

Name of the bucket to which the multipart upload was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -1897,25 +2143,25 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

", + "documentation":"

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", - "documentation":"

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

", + "documentation":"

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

", + "documentation":"

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" } @@ -1942,23 +2188,23 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "PartNumber":{ "shape":"PartNumber", - "documentation":"

Part number that identifies the part. This is a positive integer between 1 and 10,000.

" + "documentation":"

Part number that identifies the part. This is a positive integer between 1 and 10,000.

  • General purpose buckets - In CompleteMultipartUpload, when a additional checksum (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1, or x-amz-checksum-sha256) is applied to each part, the PartNumber must start at 1 and the part numbers must be consecutive. Otherwise, Amazon S3 generates an HTTP 400 Bad Request status code and an InvalidPartOrder error code.

  • Directory buckets - In CompleteMultipartUpload, the PartNumber must start at 1 and the part numbers must be consecutive.

" } }, "documentation":"

Details of the parts that were uploaded.

" @@ -2017,55 +2263,55 @@ }, "Expiration":{ "shape":"Expiration", - "documentation":"

If the object expiration is configured, the response includes this header.

", + "documentation":"

If the object expiration is configured, the response includes this header.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-expiration" }, "CopySourceVersionId":{ "shape":"CopySourceVersionId", - "documentation":"

Version of the copied object in the destination bucket.

", + "documentation":"

Version ID of the source object that was copied.

This functionality is not supported when the source object is in a directory bucket.

", "location":"header", "locationName":"x-amz-copy-source-version-id" }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

Version ID of the newly created copy.

", + "documentation":"

Version ID of the newly created copy.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-version-id" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

", + "documentation":"

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

", "location":"header", "locationName":"x-amz-server-side-encryption" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

", + "documentation":"

If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

", + "documentation":"

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, "BucketKeyEnabled":{ "shape":"BucketKeyEnabled", - "documentation":"

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

", + "documentation":"

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-bucket-key-enabled" }, @@ -2087,38 +2333,38 @@ "members":{ "ACL":{ "shape":"ObjectCannedACL", - "documentation":"

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

The canned access control list (ACL) to apply to the object.

When you copy an object, the ACL metadata is not preserved and is set to private by default. Only the owner has full access control. To override the default ACL setting, specify a new ACL when you generate a copy request. For more information, see Using ACLs.

If the destination bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

  • If your destination bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-acl" }, "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the destination bucket.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The name of the destination bucket.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "CacheControl":{ "shape":"CacheControl", - "documentation":"

Specifies caching behavior along the request/reply chain.

", + "documentation":"

Specifies the caching behavior along the request/reply chain.

", "location":"header", "locationName":"Cache-Control" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

When you copy an object, if the source object has a checksum, that checksum value will be copied to the new object by default. If the CopyObject request does not include this x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source object to the destination object (if it's present on the source object). You can optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header. Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request.

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

", "location":"header", "locationName":"x-amz-checksum-algorithm" }, "ContentDisposition":{ "shape":"ContentDisposition", - "documentation":"

Specifies presentational information for the object.

", + "documentation":"

Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.

", "location":"header", "locationName":"Content-Disposition" }, "ContentEncoding":{ "shape":"ContentEncoding", - "documentation":"

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

", + "documentation":"

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

For directory buckets, only the aws-chunked value is supported in this header field.

", "location":"header", "locationName":"Content-Encoding" }, @@ -2130,37 +2376,37 @@ }, "ContentType":{ "shape":"ContentType", - "documentation":"

A standard MIME type describing the format of the object data.

", + "documentation":"

A standard MIME type that describes the format of the object data.

", "location":"header", "locationName":"Content-Type" }, "CopySource":{ "shape":"CopySource", - "documentation":"

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf 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/object/reports/january.pdf. The value must be URL-encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

", + "documentation":"

Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.

You specify the value of the copy source in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the general purpose bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded. To copy the object reports/january.pdf from the directory bucket awsexamplebucket--use1-az5--x-s3, use awsexamplebucket--use1-az5--x-s3/reports/january.pdf. The value must be URL-encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    • Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.

    • Access points are not supported by directory buckets.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf 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/object/reports/january.pdf. The value must be URL-encoded.

If your source bucket versioning is enabled, the x-amz-copy-source header by default identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId query parameter. Specifically, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied object. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response.

If you do not enable versioning or suspend it on the destination bucket, the version ID that Amazon S3 generates in the x-amz-version-id response header is always null.

Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.

", "location":"header", "locationName":"x-amz-copy-source" }, "CopySourceIfMatch":{ "shape":"CopySourceIfMatch", - "documentation":"

Copies the object if its entity tag (ETag) matches the specified tag.

", + "documentation":"

Copies the object if its entity tag (ETag) matches the specified tag.

If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

  • x-amz-copy-source-if-match condition evaluates to true

  • x-amz-copy-source-if-unmodified-since condition evaluates to false

", "location":"header", "locationName":"x-amz-copy-source-if-match" }, "CopySourceIfModifiedSince":{ "shape":"CopySourceIfModifiedSince", - "documentation":"

Copies the object if it has been modified since the specified time.

", + "documentation":"

Copies the object if it has been modified since the specified time.

If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code:

  • x-amz-copy-source-if-none-match condition evaluates to false

  • x-amz-copy-source-if-modified-since condition evaluates to true

", "location":"header", "locationName":"x-amz-copy-source-if-modified-since" }, "CopySourceIfNoneMatch":{ "shape":"CopySourceIfNoneMatch", - "documentation":"

Copies the object if its entity tag (ETag) is different than the specified ETag.

", + "documentation":"

Copies the object if its entity tag (ETag) is different than the specified ETag.

If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code:

  • x-amz-copy-source-if-none-match condition evaluates to false

  • x-amz-copy-source-if-modified-since condition evaluates to true

", "location":"header", "locationName":"x-amz-copy-source-if-none-match" }, "CopySourceIfUnmodifiedSince":{ "shape":"CopySourceIfUnmodifiedSince", - "documentation":"

Copies the object if it hasn't been modified since the specified time.

", + "documentation":"

Copies the object if it hasn't been modified since the specified time.

If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

  • x-amz-copy-source-if-match condition evaluates to true

  • x-amz-copy-source-if-unmodified-since condition evaluates to false

", "location":"header", "locationName":"x-amz-copy-source-if-unmodified-since" }, @@ -2172,25 +2418,25 @@ }, "GrantFullControl":{ "shape":"GrantFullControl", - "documentation":"

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-full-control" }, "GrantRead":{ "shape":"GrantRead", - "documentation":"

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Allows grantee to read the object data and its metadata.

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-read" }, "GrantReadACP":{ "shape":"GrantReadACP", - "documentation":"

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Allows grantee to read the object ACL.

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-read-acp" }, "GrantWriteACP":{ "shape":"GrantWriteACP", - "documentation":"

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Allows grantee to write the ACL for the applicable object.

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-write-acp" }, @@ -2208,85 +2454,85 @@ }, "MetadataDirective":{ "shape":"MetadataDirective", - "documentation":"

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

", + "documentation":"

Specifies whether the metadata is copied from the source object or replaced with metadata that's provided in the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this header isn’t specified, COPY is the default behavior.

General purpose bucket - For general purpose buckets, when you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Amazon S3 condition key examples in the Amazon S3 User Guide.

x-amz-website-redirect-location is unique to each object and is not copied when using the x-amz-metadata-directive header. To copy the value, you must specify x-amz-website-redirect-location in the request header.

", "location":"header", "locationName":"x-amz-metadata-directive" }, "TaggingDirective":{ "shape":"TaggingDirective", - "documentation":"

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

", + "documentation":"

Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's provided in the request.

The default value is COPY.

Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:

  • When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.

  • When you attempt to REPLACE the tag-set of a source object and set a non-empty value to x-amz-tagging.

  • When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This is because the default value of x-amz-tagging-directive is COPY.

Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:

  • When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object.

  • When you attempt to REPLACE the tag-set of a directory bucket source object and set the x-amz-tagging value of the directory bucket destination object to empty.

  • When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty tags and set the x-amz-tagging value of the directory bucket destination object to empty.

  • When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the x-amz-tagging value of the directory bucket destination object. This is because the default value of x-amz-tagging is the empty value.

", "location":"header", "locationName":"x-amz-tagging-directive" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

", + "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse). Unrecognized or unsupported values won’t write a destination object and will receive a 400 Bad Request response.

Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you don't specify encryption information in your copy request, the encryption setting of the target object is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target object copy.

When you perform a CopyObject operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence.

With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption in the Amazon S3 User Guide.

For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

", "location":"header", "locationName":"x-amz-server-side-encryption" }, "StorageClass":{ "shape":"StorageClass", - "documentation":"

If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

", + "documentation":"

If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class.

  • Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

  • Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class.

You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 by using the x-amz-storage-class header. For more information, see Storage Classes in the Amazon S3 User Guide.

Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any of the following conditions:

  • The storage class of the source object is GLACIER or DEEP_ARCHIVE.

  • The storage class of the source object is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access.

For more information, see RestoreObject and Copying Objects in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-storage-class" }, "WebsiteRedirectLocation":{ "shape":"WebsiteRedirectLocation", - "documentation":"

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive header. Instead, you may opt to provide this header in combination with the directive.

", + "documentation":"

If the destination bucket is configured as a website, redirects requests for this object copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive header. Instead, you may opt to provide this header in combination with the x-amz-metadata-directive header.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-website-redirect-location" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

Specifies the algorithm to use to when encrypting the object (for example, AES256).

", + "documentation":"

Specifies the algorithm to use when encrypting the object (for example, AES256).

When you perform a CopyObject operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence.

This functionality is not supported when the destination bucket is a directory bucket.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", - "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

", + "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded. Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

This functionality is not supported when the destination bucket is a directory bucket.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

", + "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

This functionality is not supported when the destination bucket is a directory bucket.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"

Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

", + "documentation":"

Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

This functionality is not supported when the destination bucket is a directory bucket.

", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value must be explicitly added to specify encryption context for CopyObject requests.

", + "documentation":"

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value must be explicitly added to specify encryption context for CopyObject requests.

This functionality is not supported when the destination bucket is a directory bucket.

", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, "BucketKeyEnabled":{ "shape":"BucketKeyEnabled", - "documentation":"

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

", + "documentation":"

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object.

Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

This functionality is not supported when the destination bucket is a directory bucket.

", "location":"header", "locationName":"x-amz-server-side-encryption-bucket-key-enabled" }, "CopySourceSSECustomerAlgorithm":{ "shape":"CopySourceSSECustomerAlgorithm", - "documentation":"

Specifies the algorithm to use when decrypting the source object (for example, AES256).

", + "documentation":"

Specifies the algorithm to use when decrypting the source object (for example, AES256).

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

This functionality is not supported when the source object is in a directory bucket.

", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm" }, "CopySourceSSECustomerKey":{ "shape":"CopySourceSSECustomerKey", - "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

", + "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be the same one that was used when the source object was created.

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

This functionality is not supported when the source object is in a directory bucket.

", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-key" }, "CopySourceSSECustomerKeyMD5":{ "shape":"CopySourceSSECustomerKeyMD5", - "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

", + "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

This functionality is not supported when the source object is in a directory bucket.

", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5" }, @@ -2297,37 +2543,37 @@ }, "Tagging":{ "shape":"TaggingHeader", - "documentation":"

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

", + "documentation":"

The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the x-amz-tagging-directive if you choose REPLACE for the x-amz-tagging-directive. If you choose COPY for the x-amz-tagging-directive, you don't need to set the x-amz-tagging header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query parameters.

The default value is the empty value.

Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:

  • When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.

  • When you attempt to REPLACE the tag-set of a source object and set a non-empty value to x-amz-tagging.

  • When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This is because the default value of x-amz-tagging-directive is COPY.

Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:

  • When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object.

  • When you attempt to REPLACE the tag-set of a directory bucket source object and set the x-amz-tagging value of the directory bucket destination object to empty.

  • When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty tags and set the x-amz-tagging value of the directory bucket destination object to empty.

  • When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the x-amz-tagging value of the directory bucket destination object. This is because the default value of x-amz-tagging is the empty value.

", "location":"header", "locationName":"x-amz-tagging" }, "ObjectLockMode":{ "shape":"ObjectLockMode", - "documentation":"

The Object Lock mode that you want to apply to the copied object.

", + "documentation":"

The Object Lock mode that you want to apply to the object copy.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-mode" }, "ObjectLockRetainUntilDate":{ "shape":"ObjectLockRetainUntilDate", - "documentation":"

The date and time when you want the copied object's Object Lock to expire.

", + "documentation":"

The date and time when you want the Object Lock of the object copy to expire.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-retain-until-date" }, "ObjectLockLegalHoldStatus":{ "shape":"ObjectLockLegalHoldStatus", - "documentation":"

Specifies whether you want to apply a legal hold to the copied object.

", + "documentation":"

Specifies whether you want to apply a legal hold to the object copy.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-legal-hold" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, "ExpectedSourceBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-source-expected-bucket-owner" } @@ -2346,19 +2592,19 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

" } }, "documentation":"

Container for all response elements.

" @@ -2376,19 +2622,19 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" } }, "documentation":"

Container for all response elements.

" @@ -2414,7 +2660,15 @@ "members":{ "LocationConstraint":{ "shape":"BucketLocationConstraint", - "documentation":"

Specifies the Region where the bucket will be created. If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1).

" + "documentation":"

Specifies the Region where the bucket will be created. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see Accessing a bucket in the Amazon S3 User Guide.

If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default.

This functionality is not supported for directory buckets.

" + }, + "Location":{ + "shape":"LocationInfo", + "documentation":"

Specifies the location where the bucket will be created.

For directory buckets, the location type is Availability Zone.

This functionality is only supported by directory buckets.

" + }, + "Bucket":{ + "shape":"BucketInfo", + "documentation":"

Specifies the information about the bucket that will be created.

This functionality is only supported by directory buckets.

" } }, "documentation":"

The configuration information for the bucket.

" @@ -2436,13 +2690,13 @@ "members":{ "ACL":{ "shape":"BucketCannedACL", - "documentation":"

The canned ACL to apply to the bucket.

", + "documentation":"

The canned ACL to apply to the bucket.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-acl" }, "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket to create.

", + "documentation":"

The name of the bucket to create.

General purpose buckets - For information about bucket naming restrictions, see Bucket naming rules in the Amazon S3 User Guide.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -2455,37 +2709,37 @@ }, "GrantFullControl":{ "shape":"GrantFullControl", - "documentation":"

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

", + "documentation":"

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

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-grant-full-control" }, "GrantRead":{ "shape":"GrantRead", - "documentation":"

Allows grantee to list the objects in the bucket.

", + "documentation":"

Allows grantee to list the objects in the bucket.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-grant-read" }, "GrantReadACP":{ "shape":"GrantReadACP", - "documentation":"

Allows grantee to read the bucket ACL.

", + "documentation":"

Allows grantee to read the bucket ACL.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-grant-read-acp" }, "GrantWrite":{ "shape":"GrantWrite", - "documentation":"

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

", + "documentation":"

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-grant-write" }, "GrantWriteACP":{ "shape":"GrantWriteACP", - "documentation":"

Allows grantee to write the ACL for the applicable bucket.

", + "documentation":"

Allows grantee to write the ACL for the applicable bucket.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-grant-write-acp" }, "ObjectLockEnabledForBucket":{ "shape":"ObjectLockEnabledForBucket", - "documentation":"

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

", + "documentation":"

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

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-bucket-object-lock-enabled" }, @@ -2502,19 +2756,19 @@ "members":{ "AbortDate":{ "shape":"AbortDate", - "documentation":"

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

", + "documentation":"

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines the abort action.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-abort-date" }, "AbortRuleId":{ "shape":"AbortRuleId", - "documentation":"

This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

", + "documentation":"

This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-abort-rule-id" }, "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

Access points are not supported by directory buckets.

", "locationName":"Bucket" }, "Key":{ @@ -2527,37 +2781,37 @@ }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

", + "documentation":"

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

", "location":"header", "locationName":"x-amz-server-side-encryption" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

", + "documentation":"

If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

", + "documentation":"

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, "BucketKeyEnabled":{ "shape":"BucketKeyEnabled", - "documentation":"

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

", + "documentation":"

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-bucket-key-enabled" }, @@ -2583,13 +2837,13 @@ "members":{ "ACL":{ "shape":"ObjectCannedACL", - "documentation":"

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL in the Amazon S3 User Guide.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more information, see Using ACLs. One way to grant the permissions using the request headers is to specify a canned ACL with the x-amz-acl request header.

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-acl" }, "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket to which to initiate the upload

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The name of the bucket where the multipart upload is initiated and where the object is uploaded.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -2608,13 +2862,13 @@ }, "ContentEncoding":{ "shape":"ContentEncoding", - "documentation":"

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

", + "documentation":"

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

For directory buckets, only the aws-chunked value is supported in this header field.

", "location":"header", "locationName":"Content-Encoding" }, "ContentLanguage":{ "shape":"ContentLanguage", - "documentation":"

The language the content is in.

", + "documentation":"

The language that the content is in.

", "location":"header", "locationName":"Content-Language" }, @@ -2632,25 +2886,25 @@ }, "GrantFullControl":{ "shape":"GrantFullControl", - "documentation":"

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

  • id – if the value specified is the canonical user ID of an Amazon Web Services account

  • uri – if you are granting permissions to a predefined group

  • emailAddress – if the value specified is the email address of an Amazon Web Services account

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-full-control" }, "GrantRead":{ "shape":"GrantRead", - "documentation":"

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Specify access permissions explicitly to allow grantee to read the object data and its metadata.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

  • id – if the value specified is the canonical user ID of an Amazon Web Services account

  • uri – if you are granting permissions to a predefined group

  • emailAddress – if the value specified is the email address of an Amazon Web Services account

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-read" }, "GrantReadACP":{ "shape":"GrantReadACP", - "documentation":"

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Specify access permissions explicitly to allows grantee to read the object ACL.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

  • id – if the value specified is the canonical user ID of an Amazon Web Services account

  • uri – if you are granting permissions to a predefined group

  • emailAddress – if the value specified is the email address of an Amazon Web Services account

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-read-acp" }, "GrantWriteACP":{ "shape":"GrantWriteACP", - "documentation":"

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

  • id – if the value specified is the canonical user ID of an Amazon Web Services account

  • uri – if you are granting permissions to a predefined group

  • emailAddress – if the value specified is the email address of an Amazon Web Services account

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-write-acp" }, @@ -2669,55 +2923,55 @@ }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

", + "documentation":"

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

", "location":"header", "locationName":"x-amz-server-side-encryption" }, "StorageClass":{ "shape":"StorageClass", - "documentation":"

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

", + "documentation":"

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

  • For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.

  • Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.

", "location":"header", "locationName":"x-amz-storage-class" }, "WebsiteRedirectLocation":{ "shape":"WebsiteRedirectLocation", - "documentation":"

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

", + "documentation":"

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-website-redirect-location" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

Specifies the algorithm to use to when encrypting the object (for example, AES256).

", + "documentation":"

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", - "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

", + "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

", + "documentation":"

Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"

Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

", + "documentation":"

Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for object encryption.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

", + "documentation":"

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, "BucketKeyEnabled":{ "shape":"BucketKeyEnabled", - "documentation":"

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

", + "documentation":"

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-bucket-key-enabled" }, @@ -2728,43 +2982,77 @@ }, "Tagging":{ "shape":"TaggingHeader", - "documentation":"

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

", + "documentation":"

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-tagging" }, "ObjectLockMode":{ "shape":"ObjectLockMode", - "documentation":"

Specifies the Object Lock mode that you want to apply to the uploaded object.

", + "documentation":"

Specifies the Object Lock mode that you want to apply to the uploaded object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-mode" }, "ObjectLockRetainUntilDate":{ "shape":"ObjectLockRetainUntilDate", - "documentation":"

Specifies the date and time when you want the Object Lock to expire.

", + "documentation":"

Specifies the date and time when you want the Object Lock to expire.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-retain-until-date" }, "ObjectLockLegalHoldStatus":{ "shape":"ObjectLockLegalHoldStatus", - "documentation":"

Specifies whether you want to apply a legal hold to the uploaded object.

", + "documentation":"

Specifies whether you want to apply a legal hold to the uploaded object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-legal-hold" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-algorithm" } } }, + "CreateSessionOutput":{ + "type":"structure", + "required":["Credentials"], + "members":{ + "Credentials":{ + "shape":"SessionCredentials", + "documentation":"

The established temporary security credentials for the created session..

", + "locationName":"Credentials" + } + } + }, + "CreateSessionRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "SessionMode":{ + "shape":"SessionMode", + "documentation":"

Specifies the mode of the session that will be created, either ReadWrite or ReadOnly. By default, a ReadWrite session is created. A ReadWrite session is capable of executing all the Zonal endpoint APIs on a directory bucket. A ReadOnly session is constrained to execute the following Zonal endpoint APIs: GetObject, HeadObject, ListObjectsV2, GetObjectAttributes, ListParts, and ListMultipartUploads.

", + "location":"header", + "locationName":"x-amz-create-session-mode" + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

The name of the bucket that you create a session for.

", + "contextParam":{"name":"Bucket"}, + "location":"uri", + "locationName":"Bucket" + } + } + }, "CreationDate":{"type":"timestamp"}, + "DataRedundancy":{ + "type":"string", + "enum":["SingleAvailabilityZone"] + }, "Date":{ "type":"timestamp", "timestampFormat":"iso8601" @@ -2801,12 +3089,12 @@ "members":{ "Objects":{ "shape":"ObjectIdentifierList", - "documentation":"

The object to delete.

", + "documentation":"

The object to delete.

Directory buckets - For directory buckets, an object that's composed entirely of whitespace characters is not supported by the DeleteObjects API operation. The request will receive a 400 Bad Request error and none of the objects in the request will be deleted.

", "locationName":"Object" }, "Quiet":{ "shape":"Quiet", - "documentation":"

Element to enable quiet mode for the request. When you add this element, you must set its value to true.

" + "documentation":"

Element to enable quiet mode for the request. When you add this element, you must set its value to true.

" } }, "documentation":"

Container for the objects to delete.

" @@ -2833,7 +3121,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -2852,7 +3140,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -2871,7 +3159,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -2921,7 +3209,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -2940,7 +3228,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -2968,7 +3256,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -2987,7 +3275,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -2999,14 +3287,14 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name.

", + "documentation":"

The bucket name.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3025,7 +3313,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3037,14 +3325,14 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

Specifies the bucket being deleted.

", + "documentation":"

Specifies the bucket being deleted.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3063,7 +3351,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3082,7 +3370,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3143,13 +3431,13 @@ "members":{ "DeleteMarker":{ "shape":"DeleteMarker", - "documentation":"

Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

", + "documentation":"

Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-delete-marker" }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

Returns the version ID of the delete marker created as a result of the DELETE operation.

", + "documentation":"

Returns the version ID of the delete marker created as a result of the DELETE operation.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-version-id" }, @@ -3169,7 +3457,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name of the bucket containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The bucket name of the bucket containing the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -3183,13 +3471,13 @@ }, "MFA":{ "shape":"MFA", - "documentation":"

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

", + "documentation":"

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-mfa" }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

VersionId used to reference a specific version of the object.

", + "documentation":"

Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

", "location":"querystring", "locationName":"versionId" }, @@ -3200,13 +3488,13 @@ }, "BypassGovernanceRetention":{ "shape":"BypassGovernanceRetention", - "documentation":"

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.

", + "documentation":"

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-bypass-governance-retention" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3232,7 +3520,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name containing the objects from which to remove the tags.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The bucket name containing the objects from which to remove the tags.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -3251,7 +3539,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3285,7 +3573,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name containing the objects to delete.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The bucket name containing the objects to delete.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -3298,7 +3586,7 @@ }, "MFA":{ "shape":"MFA", - "documentation":"

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

", + "documentation":"

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

When performing the DeleteObjects operation on an MFA delete enabled bucket, which attempts to delete the specified versioned objects, you must include an MFA token. If you don't provide an MFA token, the entire request will fail, even if there are non-versioned objects that you are trying to delete. If you provide an invalid token, whether there are versioned object keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-mfa" }, @@ -3309,19 +3597,19 @@ }, "BypassGovernanceRetention":{ "shape":"BypassGovernanceRetention", - "documentation":"

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:BypassGovernanceRetention permission.

", + "documentation":"

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:BypassGovernanceRetention permission.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-bypass-governance-retention" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:

  • CRC32

  • CRC32C

  • SHA1

  • SHA256

For more information, see Checking object integrity in the Amazon S3 User Guide.

If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" } @@ -3341,7 +3629,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3356,15 +3644,15 @@ }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

The version ID of the deleted object.

" + "documentation":"

The version ID of the deleted object.

This functionality is not supported for directory buckets.

" }, "DeleteMarker":{ "shape":"DeleteMarker", - "documentation":"

Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

" + "documentation":"

Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

This functionality is not supported for directory buckets.

" }, "DeleteMarkerVersionId":{ "shape":"DeleteMarkerVersionId", - "documentation":"

The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.

" + "documentation":"

The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.

This functionality is not supported for directory buckets.

" } }, "documentation":"

Information about the deleted object.

" @@ -3411,6 +3699,11 @@ }, "documentation":"

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

" }, + "DirectoryBucketToken":{ + "type":"string", + "max":1024, + "min":0 + }, "DisplayName":{"type":"string"}, "ETag":{"type":"string"}, "EmailAddress":{"type":"string"}, @@ -3472,7 +3765,7 @@ }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

The version ID of the error.

" + "documentation":"

The version ID of the error.

This functionality is not supported for directory buckets.

" }, "Code":{ "shape":"Code", @@ -3657,7 +3950,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, @@ -3688,14 +3981,14 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

Specifies the S3 bucket whose ACL is being requested.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

", + "documentation":"

Specifies the S3 bucket whose ACL is being requested.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3733,7 +4026,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3755,14 +4048,14 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name for which to get the cors configuration.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

", + "documentation":"

The bucket name for which to get the cors configuration.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3788,7 +4081,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3858,7 +4151,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3887,7 +4180,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3916,7 +4209,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3937,14 +4230,14 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket for which to get the location.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

", + "documentation":"

The name of the bucket for which to get the location.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -3969,7 +4262,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4007,7 +4300,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4019,14 +4312,14 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket for which to get the notification configuration.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

", + "documentation":"

The name of the bucket for which to get the notification configuration.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4055,7 +4348,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4077,14 +4370,14 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name for which to get the bucket policy.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

", + "documentation":"

The bucket name to get the bucket policy for.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

Access points - When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

Access points and Object Lambda access points are not supported by directory buckets.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4113,7 +4406,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4139,7 +4432,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4167,7 +4460,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4196,7 +4489,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4229,7 +4522,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4269,7 +4562,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4303,7 +4596,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name that contains the object for which to get the ACL information.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "documentation":"

The bucket name that contains the object for which to get the ACL information.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -4317,7 +4610,7 @@ }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

VersionId used to reference a specific version of the object.

", + "documentation":"

Version ID used to reference a specific version of the object.

This functionality is not supported for directory buckets.

", "location":"querystring", "locationName":"versionId" }, @@ -4328,7 +4621,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4339,7 +4632,7 @@ "members":{ "DeleteMarker":{ "shape":"DeleteMarker", - "documentation":"

Specifies whether the object retrieved was (true) or was not (false) a delete marker. If false, this response header does not appear in the response.

", + "documentation":"

Specifies whether the object retrieved was (true) or was not (false) a delete marker. If false, this response header does not appear in the response.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-delete-marker" }, @@ -4351,7 +4644,7 @@ }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

The version ID of the object.

", + "documentation":"

The version ID of the object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-version-id" }, @@ -4374,7 +4667,7 @@ }, "StorageClass":{ "shape":"StorageClass", - "documentation":"

Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

" + "documentation":"

Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

" }, "ObjectSize":{ "shape":"ObjectSize", @@ -4408,7 +4701,7 @@ }, "Parts":{ "shape":"PartsList", - "documentation":"

A container for elements related to a particular part. A response can contain zero or more Parts elements.

", + "documentation":"

A container for elements related to a particular part. A response can contain zero or more Parts elements.

  • General purpose buckets - For GetObjectAttributes, if a additional checksum (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1, or x-amz-checksum-sha256) isn't applied to the object specified in the request, the response doesn't return Part.

  • Directory buckets - For GetObjectAttributes, no matter whether a additional checksum is applied to the object specified in the request, the response returns Part.

", "locationName":"Part" } }, @@ -4424,7 +4717,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket that contains the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The name of the bucket that contains the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -4437,7 +4730,7 @@ }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

The version ID used to reference a specific version of the object.

", + "documentation":"

The version ID used to reference a specific version of the object.

S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

", "location":"querystring", "locationName":"versionId" }, @@ -4455,19 +4748,19 @@ }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

Specifies the algorithm to use when encrypting the object (for example, AES256).

", + "documentation":"

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", - "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

", + "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

", + "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, @@ -4478,7 +4771,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, @@ -4509,7 +4802,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name containing the object whose legal hold status you want to retrieve.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "documentation":"

The bucket name containing the object whose legal hold status you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -4533,7 +4826,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4555,14 +4848,14 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket whose Object Lock configuration you want to retrieve.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "documentation":"

The bucket whose Object Lock configuration you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -4578,31 +4871,31 @@ }, "DeleteMarker":{ "shape":"DeleteMarker", - "documentation":"

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

", + "documentation":"

Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

  • If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

  • If the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

", "location":"header", "locationName":"x-amz-delete-marker" }, "AcceptRanges":{ "shape":"AcceptRanges", - "documentation":"

Indicates that a range of bytes was specified.

", + "documentation":"

Indicates that a range of bytes was specified in the request.

", "location":"header", "locationName":"accept-ranges" }, "Expiration":{ "shape":"Expiration", - "documentation":"

If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

", + "documentation":"

If the object expiration is configured (see PutBucketLifecycleConfiguration ), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-expiration" }, "Restore":{ "shape":"Restore", - "documentation":"

Provides information about object restoration action and expiration time of the restored object copy.

", + "documentation":"

Provides information about object restoration action and expiration time of the restored object copy.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

", "location":"header", "locationName":"x-amz-restore" }, "LastModified":{ "shape":"LastModified", - "documentation":"

Date and time when the object was last modified.

", + "documentation":"

Date and time when the object was last modified.

General purpose buckets - When you specify a versionId of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

", "location":"header", "locationName":"Last-Modified" }, @@ -4620,37 +4913,37 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-crc32c" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-sha256" }, "MissingMeta":{ "shape":"MissingMeta", - "documentation":"

This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

", + "documentation":"

This is set to the number of metadata entries not returned in the headers that are prefixed with x-amz-meta-. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-missing-meta" }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

Version of the object.

", + "documentation":"

Version ID of the object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-version-id" }, @@ -4668,7 +4961,7 @@ }, "ContentEncoding":{ "shape":"ContentEncoding", - "documentation":"

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

", + "documentation":"

Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

", "location":"header", "locationName":"Content-Encoding" }, @@ -4698,13 +4991,13 @@ }, "WebsiteRedirectLocation":{ "shape":"WebsiteRedirectLocation", - "documentation":"

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

", + "documentation":"

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-website-redirect-location" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

", + "documentation":"

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

", "location":"header", "locationName":"x-amz-server-side-encryption" }, @@ -4716,31 +5009,31 @@ }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

", + "documentation":"

If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "BucketKeyEnabled":{ "shape":"BucketKeyEnabled", - "documentation":"

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

", + "documentation":"

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-bucket-key-enabled" }, "StorageClass":{ "shape":"StorageClass", - "documentation":"

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

", + "documentation":"

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

", "location":"header", "locationName":"x-amz-storage-class" }, @@ -4751,7 +5044,7 @@ }, "ReplicationStatus":{ "shape":"ReplicationStatus", - "documentation":"

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

", + "documentation":"

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-replication-status" }, @@ -4763,25 +5056,25 @@ }, "TagCount":{ "shape":"TagCount", - "documentation":"

The number of tags, if any, on the object.

", + "documentation":"

The number of tags, if any, on the object, when you have the relevant permission to read object tags.

You can use GetObjectTagging to retrieve the tag set associated with an object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-tagging-count" }, "ObjectLockMode":{ "shape":"ObjectLockMode", - "documentation":"

The Object Lock mode currently in place for this object.

", + "documentation":"

The Object Lock mode that's currently in place for this object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-mode" }, "ObjectLockRetainUntilDate":{ "shape":"ObjectLockRetainUntilDate", - "documentation":"

The date and time when this object's Object Lock will expire.

", + "documentation":"

The date and time when this object's Object Lock will expire.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-retain-until-date" }, "ObjectLockLegalHoldStatus":{ "shape":"ObjectLockLegalHoldStatus", - "documentation":"

Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.

", + "documentation":"

Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-legal-hold" } @@ -4797,32 +5090,32 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The bucket name containing the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Object Lambda access points - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "IfMatch":{ "shape":"IfMatch", - "documentation":"

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

", + "documentation":"

Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

", "location":"header", "locationName":"If-Match" }, "IfModifiedSince":{ "shape":"IfModifiedSince", - "documentation":"

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

", + "documentation":"

Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified status code.

For more information about conditional requests, see RFC 7232.

", "location":"header", "locationName":"If-Modified-Since" }, "IfNoneMatch":{ "shape":"IfNoneMatch", - "documentation":"

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

", + "documentation":"

Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified HTTP status code.

For more information about conditional requests, see RFC 7232.

", "location":"header", "locationName":"If-None-Match" }, "IfUnmodifiedSince":{ "shape":"IfUnmodifiedSince", - "documentation":"

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

", + "documentation":"

Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

", "location":"header", "locationName":"If-Unmodified-Since" }, @@ -4835,7 +5128,7 @@ }, "Range":{ "shape":"Range", - "documentation":"

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

", + "documentation":"

Downloads the specified byte range of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

", "location":"header", "locationName":"Range" }, @@ -4847,7 +5140,7 @@ }, "ResponseContentDisposition":{ "shape":"ResponseContentDisposition", - "documentation":"

Sets the Content-Disposition header of the response

", + "documentation":"

Sets the Content-Disposition header of the response.

", "location":"querystring", "locationName":"response-content-disposition" }, @@ -4877,25 +5170,25 @@ }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

VersionId used to reference a specific version of the object.

", + "documentation":"

Version ID used to reference a specific version of the object.

By default, the GetObject operation returns the current version of an object. To return a different version, use the versionId subresource.

  • If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.

  • If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.

  • Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

For more information about versioning, see PutBucketVersioning.

", "location":"querystring", "locationName":"versionId" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

Specifies the algorithm to use to when decrypting the object (for example, AES256).

", + "documentation":"

Specifies the algorithm to use when decrypting the object (for example, AES256).

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", - "documentation":"

Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

", + "documentation":"

Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

", + "documentation":"

Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, @@ -4912,7 +5205,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, @@ -4947,7 +5240,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name containing the object whose retention settings you want to retrieve.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "documentation":"

The bucket name containing the object whose retention settings you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -4971,7 +5264,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -5002,7 +5295,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name containing the object for which to get the tagging information.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The bucket name containing the object for which to get the tagging information.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -5021,7 +5314,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, @@ -5075,7 +5368,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -5104,7 +5397,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -5180,20 +5473,49 @@ "locationName":"Grant" } }, + "HeadBucketOutput":{ + "type":"structure", + "members":{ + "BucketLocationType":{ + "shape":"LocationType", + "documentation":"

The type of location where the bucket is created.

This functionality is only supported by directory buckets.

", + "location":"header", + "locationName":"x-amz-bucket-location-type" + }, + "BucketLocationName":{ + "shape":"BucketLocationName", + "documentation":"

The name of the location where the bucket will be created.

For directory buckets, the AZ ID of the Availability Zone where the bucket is created. An example AZ ID value is usw2-az2.

This functionality is only supported by directory buckets.

", + "location":"header", + "locationName":"x-amz-bucket-location-name" + }, + "BucketRegion":{ + "shape":"Region", + "documentation":"

The Region that the bucket is located.

This functionality is not supported for directory buckets.

", + "location":"header", + "locationName":"x-amz-bucket-region" + }, + "AccessPointAlias":{ + "shape":"AccessPointAlias", + "documentation":"

Indicates whether the bucket name used in the request is an access point alias.

This functionality is not supported for directory buckets.

", + "location":"header", + "locationName":"x-amz-access-point-alias" + } + } + }, "HeadBucketRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The bucket name.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -5204,7 +5526,7 @@ "members":{ "DeleteMarker":{ "shape":"DeleteMarker", - "documentation":"

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

", + "documentation":"

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-delete-marker" }, @@ -5216,19 +5538,19 @@ }, "Expiration":{ "shape":"Expiration", - "documentation":"

If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

", + "documentation":"

If the object expiration is configured (see PutBucketLifecycleConfiguration ), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-expiration" }, "Restore":{ "shape":"Restore", - "documentation":"

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 21 Dec 2012 00:00:00 GMT\"

If the object restoration is in progress, the header returns the value ongoing-request=\"true\".

For more information about archiving objects, see Transitioning Objects: General Considerations.

", + "documentation":"

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 21 Dec 2012 00:00:00 GMT\"

If the object restoration is in progress, the header returns the value ongoing-request=\"true\".

For more information about archiving objects, see Transitioning Objects: General Considerations.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

", "location":"header", "locationName":"x-amz-restore" }, "ArchiveStatus":{ "shape":"ArchiveStatus", - "documentation":"

The archive state of the head object.

", + "documentation":"

The archive state of the head object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-archive-status" }, @@ -5246,25 +5568,25 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-crc32c" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-sha256" }, @@ -5276,13 +5598,13 @@ }, "MissingMeta":{ "shape":"MissingMeta", - "documentation":"

This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

", + "documentation":"

This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-missing-meta" }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

Version of the object.

", + "documentation":"

Version ID of the object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-version-id" }, @@ -5300,7 +5622,7 @@ }, "ContentEncoding":{ "shape":"ContentEncoding", - "documentation":"

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

", + "documentation":"

Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

", "location":"header", "locationName":"Content-Encoding" }, @@ -5324,13 +5646,13 @@ }, "WebsiteRedirectLocation":{ "shape":"WebsiteRedirectLocation", - "documentation":"

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

", + "documentation":"

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-website-redirect-location" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

", + "documentation":"

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

", "location":"header", "locationName":"x-amz-server-side-encryption" }, @@ -5342,31 +5664,31 @@ }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

", + "documentation":"

If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "BucketKeyEnabled":{ "shape":"BucketKeyEnabled", - "documentation":"

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

", + "documentation":"

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-bucket-key-enabled" }, "StorageClass":{ "shape":"StorageClass", - "documentation":"

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

", + "documentation":"

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

", "location":"header", "locationName":"x-amz-storage-class" }, @@ -5377,7 +5699,7 @@ }, "ReplicationStatus":{ "shape":"ReplicationStatus", - "documentation":"

Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

  • If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

    For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

  • If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

  • When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

For more information, see Replication.

", + "documentation":"

Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

  • If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

    For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

  • If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

  • When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

For more information, see Replication.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-replication-status" }, @@ -5389,19 +5711,19 @@ }, "ObjectLockMode":{ "shape":"ObjectLockMode", - "documentation":"

The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

", + "documentation":"

The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-mode" }, "ObjectLockRetainUntilDate":{ "shape":"ObjectLockRetainUntilDate", - "documentation":"

The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

", + "documentation":"

The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-retain-until-date" }, "ObjectLockLegalHoldStatus":{ "shape":"ObjectLockLegalHoldStatus", - "documentation":"

Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

", + "documentation":"

Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-legal-hold" } @@ -5416,32 +5738,32 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The name of the bucket that contains the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "IfMatch":{ "shape":"IfMatch", - "documentation":"

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

", + "documentation":"

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

  • If-Match condition evaluates to true, and;

  • If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

", "location":"header", "locationName":"If-Match" }, "IfModifiedSince":{ "shape":"IfModifiedSince", - "documentation":"

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

", + "documentation":"

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

  • If-None-Match condition evaluates to false, and;

  • If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

", "location":"header", "locationName":"If-Modified-Since" }, "IfNoneMatch":{ "shape":"IfNoneMatch", - "documentation":"

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

", + "documentation":"

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

  • If-None-Match condition evaluates to false, and;

  • If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

", "location":"header", "locationName":"If-None-Match" }, "IfUnmodifiedSince":{ "shape":"IfUnmodifiedSince", - "documentation":"

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

", + "documentation":"

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

  • If-Match condition evaluates to true, and;

  • If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

", "location":"header", "locationName":"If-Unmodified-Since" }, @@ -5460,25 +5782,25 @@ }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

VersionId used to reference a specific version of the object.

", + "documentation":"

Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

", "location":"querystring", "locationName":"versionId" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

Specifies the algorithm to use to when encrypting the object (for example, AES256).

", + "documentation":"

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", - "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

", + "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

", + "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, @@ -5495,7 +5817,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, @@ -5532,11 +5854,11 @@ "members":{ "ID":{ "shape":"ID", - "documentation":"

If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.

" + "documentation":"

If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.

Directory buckets - If the principal is an Amazon Web Services account, it provides the Amazon Web Services account ID. If the principal is an IAM User, it provides a user ARN value.

" }, "DisplayName":{ "shape":"DisplayName", - "documentation":"

Name of the Principal.

" + "documentation":"

Name of the Principal.

This functionality is not supported for directory buckets.

" } }, "documentation":"

Container element that identifies who initiated the multipart upload.

" @@ -5652,7 +5974,8 @@ "StorageClass":{"shape":"StorageClass"}, "AccessTier":{"shape":"IntelligentTieringAccessTier"} }, - "documentation":"

Object is archived and inaccessible until restored.

", + "documentation":"

Object is archived and inaccessible until restored.

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.

", + "error":{"httpStatusCode":403}, "exception":true }, "InventoryConfiguration":{ @@ -6073,7 +6396,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -6161,7 +6484,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -6208,7 +6531,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -6227,6 +6550,36 @@ } } }, + "ListDirectoryBucketsOutput":{ + "type":"structure", + "members":{ + "Buckets":{ + "shape":"Buckets", + "documentation":"

The list of buckets owned by the requester.

" + }, + "ContinuationToken":{ + "shape":"DirectoryBucketToken", + "documentation":"

If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response.

" + } + } + }, + "ListDirectoryBucketsRequest":{ + "type":"structure", + "members":{ + "ContinuationToken":{ + "shape":"DirectoryBucketToken", + "documentation":"

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

", + "location":"querystring", + "locationName":"continuation-token" + }, + "MaxDirectoryBuckets":{ + "shape":"MaxDirectoryBuckets", + "documentation":"

Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.

", + "location":"querystring", + "locationName":"max-directory-buckets" + } + } + }, "ListMultipartUploadsOutput":{ "type":"structure", "members":{ @@ -6240,7 +6593,7 @@ }, "UploadIdMarker":{ "shape":"UploadIdMarker", - "documentation":"

Upload ID after which listing began.

" + "documentation":"

Upload ID after which listing began.

This functionality is not supported for directory buckets.

" }, "NextKeyMarker":{ "shape":"NextKeyMarker", @@ -6248,15 +6601,15 @@ }, "Prefix":{ "shape":"Prefix", - "documentation":"

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

" + "documentation":"

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

" }, "Delimiter":{ "shape":"Delimiter", - "documentation":"

Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

" + "documentation":"

Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

" }, "NextUploadIdMarker":{ "shape":"NextUploadIdMarker", - "documentation":"

When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

" + "documentation":"

When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

This functionality is not supported for directory buckets.

" }, "MaxUploads":{ "shape":"MaxUploads", @@ -6273,7 +6626,7 @@ }, "CommonPrefixes":{ "shape":"CommonPrefixList", - "documentation":"

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

" + "documentation":"

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

" }, "EncodingType":{ "shape":"EncodingType", @@ -6292,14 +6645,14 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket to which the multipart upload was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The name of the bucket to which the multipart upload was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "Delimiter":{ "shape":"Delimiter", - "documentation":"

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

", + "documentation":"

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

", "location":"querystring", "locationName":"delimiter" }, @@ -6310,7 +6663,7 @@ }, "KeyMarker":{ "shape":"KeyMarker", - "documentation":"

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

", + "documentation":"

Specifies the multipart upload after which listing should begin.

  • General purpose buckets - For general purpose buckets, key-marker is an object key. Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

    If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

    If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

  • Directory buckets - For directory buckets, key-marker is obfuscated and isn't a real object key. The upload-id-marker parameter isn't supported by directory buckets. To list the additional multipart uploads, you only need to set the value of key-marker to the NextKeyMarker value from the previous response.

    In the ListMultipartUploads response, the multipart uploads aren't sorted lexicographically based on the object keys.

", "location":"querystring", "locationName":"key-marker" }, @@ -6322,20 +6675,20 @@ }, "Prefix":{ "shape":"Prefix", - "documentation":"

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way that you'd use a folder in a file system.)

", + "documentation":"

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way that you'd use a folder in a file system.)

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

", "contextParam":{"name":"Prefix"}, "location":"querystring", "locationName":"prefix" }, "UploadIdMarker":{ "shape":"UploadIdMarker", - "documentation":"

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

", + "documentation":"

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

This functionality is not supported for directory buckets.

", "location":"querystring", "locationName":"upload-id-marker" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, @@ -6459,7 +6812,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, @@ -6532,7 +6885,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket containing the objects.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The name of the bucket containing the objects.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -6575,7 +6928,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, @@ -6600,15 +6953,15 @@ }, "Name":{ "shape":"BucketName", - "documentation":"

The bucket name.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

" + "documentation":"

The bucket name.

" }, "Prefix":{ "shape":"Prefix", - "documentation":"

Keys that begin with the indicated prefix.

" + "documentation":"

Keys that begin with the indicated prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

" }, "Delimiter":{ "shape":"Delimiter", - "documentation":"

Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

" + "documentation":"

Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

Directory buckets - For directory buckets, / is the only supported delimiter.

" }, "MaxKeys":{ "shape":"MaxKeys", @@ -6616,7 +6969,7 @@ }, "CommonPrefixes":{ "shape":"CommonPrefixList", - "documentation":"

All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

" + "documentation":"

All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

  • Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

  • Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.

" }, "EncodingType":{ "shape":"EncodingType", @@ -6628,7 +6981,7 @@ }, "ContinuationToken":{ "shape":"Token", - "documentation":"

If ContinuationToken was sent with the request, it is included in the response.

" + "documentation":"

If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response. You can use this ContinuationToken for pagination of the list results.

" }, "NextContinuationToken":{ "shape":"NextToken", @@ -6636,7 +6989,7 @@ }, "StartAfter":{ "shape":"StartAfter", - "documentation":"

If StartAfter was sent with the request, it is included in the response.

" + "documentation":"

If StartAfter was sent with the request, it is included in the response.

This functionality is not supported for directory buckets.

" }, "RequestCharged":{ "shape":"RequestCharged", @@ -6651,14 +7004,14 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

Bucket name to list.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "Delimiter":{ "shape":"Delimiter", - "documentation":"

A delimiter is a character that you use to group keys.

", + "documentation":"

A delimiter is a character that you use to group keys.

  • Directory buckets - For directory buckets, / is the only supported delimiter.

  • Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.

", "location":"querystring", "locationName":"delimiter" }, @@ -6676,44 +7029,44 @@ }, "Prefix":{ "shape":"Prefix", - "documentation":"

Limits the response to keys that begin with the specified prefix.

", + "documentation":"

Limits the response to keys that begin with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

", "contextParam":{"name":"Prefix"}, "location":"querystring", "locationName":"prefix" }, "ContinuationToken":{ "shape":"Token", - "documentation":"

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

", + "documentation":"

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

", "location":"querystring", "locationName":"continuation-token" }, "FetchOwner":{ "shape":"FetchOwner", - "documentation":"

The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

", + "documentation":"

The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.

", "location":"querystring", "locationName":"fetch-owner" }, "StartAfter":{ "shape":"StartAfter", - "documentation":"

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

", + "documentation":"

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

This functionality is not supported for directory buckets.

", "location":"querystring", "locationName":"start-after" }, "RequestPayer":{ "shape":"RequestPayer", - "documentation":"

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

", + "documentation":"

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-request-payer" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, "OptionalObjectAttributes":{ "shape":"OptionalObjectAttributesList", - "documentation":"

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

", + "documentation":"

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-optional-object-attributes" } @@ -6724,13 +7077,13 @@ "members":{ "AbortDate":{ "shape":"AbortDate", - "documentation":"

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

The response will also include the x-amz-abort-rule-id header that will provide the ID of the lifecycle configuration rule that defines this action.

", + "documentation":"

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

The response will also include the x-amz-abort-rule-id header that will provide the ID of the lifecycle configuration rule that defines this action.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-abort-date" }, "AbortRuleId":{ "shape":"AbortRuleId", - "documentation":"

This header is returned along with the x-amz-abort-date header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

", + "documentation":"

This header is returned along with the x-amz-abort-date header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-abort-rule-id" }, @@ -6764,7 +7117,7 @@ }, "Parts":{ "shape":"Parts", - "documentation":"

Container for elements related to a particular part. A response can contain zero or more Part elements.

", + "documentation":"

Container for elements related to a particular part. A response can contain zero or more Part elements.

", "locationName":"Part" }, "Initiator":{ @@ -6773,11 +7126,11 @@ }, "Owner":{ "shape":"Owner", - "documentation":"

Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

" + "documentation":"

Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

Directory buckets - The bucket owner is returned as the object owner for all the parts.

" }, "StorageClass":{ "shape":"StorageClass", - "documentation":"

Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.

" + "documentation":"

The class of storage used to store the uploaded object.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

" }, "RequestCharged":{ "shape":"RequestCharged", @@ -6800,7 +7153,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket to which the parts are being uploaded.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The name of the bucket to which the parts are being uploaded.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -6837,32 +7190,51 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

", + "documentation":"

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", - "documentation":"

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

", + "documentation":"

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

", + "documentation":"

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" } } }, "Location":{"type":"string"}, + "LocationInfo":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"LocationType", + "documentation":"

The type of location where the bucket will be created.

" + }, + "Name":{ + "shape":"LocationNameAsString", + "documentation":"

The name of the location where the bucket will be created.

For directory buckets, the AZ ID of the Availability Zone where the bucket will be created. An example AZ ID value is usw2-az2.

" + } + }, + "documentation":"

Specifies the location where the bucket will be created.

For directory buckets, the location type is Availability Zone. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.

" + }, + "LocationNameAsString":{"type":"string"}, "LocationPrefix":{"type":"string"}, + "LocationType":{ + "type":"string", + "enum":["AvailabilityZone"] + }, "LoggingEnabled":{ "type":"structure", "required":[ @@ -6909,6 +7281,12 @@ "type":"integer", "box":true }, + "MaxDirectoryBuckets":{ + "type":"integer", + "box":true, + "max":1000, + "min":0 + }, "MaxKeys":{"type":"integer"}, "MaxParts":{"type":"integer"}, "MaxUploads":{"type":"integer"}, @@ -7048,11 +7426,11 @@ }, "StorageClass":{ "shape":"StorageClass", - "documentation":"

The class of storage used to store the object.

" + "documentation":"

The class of storage used to store the object.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

" }, "Owner":{ "shape":"Owner", - "documentation":"

Specifies the owner of the object that is part of the multipart upload.

" + "documentation":"

Specifies the owner of the object that is part of the multipart upload.

Directory buckets - The bucket owner is returned as the object owner for all the objects.

" }, "Initiator":{ "shape":"Initiator", @@ -7085,6 +7463,7 @@ "members":{ }, "documentation":"

The specified bucket does not exist.

", + "error":{"httpStatusCode":404}, "exception":true }, "NoSuchKey":{ @@ -7092,6 +7471,7 @@ "members":{ }, "documentation":"

The specified key does not exist.

", + "error":{"httpStatusCode":404}, "exception":true }, "NoSuchUpload":{ @@ -7099,6 +7479,7 @@ "members":{ }, "documentation":"

The specified multipart upload does not exist.

", + "error":{"httpStatusCode":404}, "exception":true }, "NoncurrentVersionExpiration":{ @@ -7207,7 +7588,7 @@ }, "ETag":{ "shape":"ETag", - "documentation":"

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

  • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.

" + "documentation":"

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

  • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.

Directory buckets - MD5 is not supported by directory buckets.

" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithmList", @@ -7219,15 +7600,15 @@ }, "StorageClass":{ "shape":"ObjectStorageClass", - "documentation":"

The class of storage used to store the object.

" + "documentation":"

The class of storage used to store the object.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

" }, "Owner":{ "shape":"Owner", - "documentation":"

The owner of the object

" + "documentation":"

The owner of the object

Directory buckets - The bucket owner is returned as the object owner.

" }, "RestoreStatus":{ "shape":"RestoreStatus", - "documentation":"

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

" + "documentation":"

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

" } }, "documentation":"

An object consists of data and its descriptive metadata.

" @@ -7237,6 +7618,7 @@ "members":{ }, "documentation":"

This action is not allowed against this storage tier.

", + "error":{"httpStatusCode":403}, "exception":true }, "ObjectAttributes":{ @@ -7275,7 +7657,7 @@ }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

VersionId for the specific version of the object to delete.

" + "documentation":"

Version ID for the specific version of the object to delete.

This functionality is not supported for directory buckets.

" } }, "documentation":"

Object Identifier is unique value to identify objects.

" @@ -7381,11 +7763,12 @@ "members":{ }, "documentation":"

The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.

", + "error":{"httpStatusCode":403}, "exception":true }, "ObjectOwnership":{ "type":"string", - "documentation":"

The container element for object ownership for a bucket's ownership controls.

BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format.

", + "documentation":"

The container element for object ownership for a bucket's ownership controls.

BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control canned ACL or a custom ACL in XML format that grants the same permissions).

By default, ObjectOwnership is set to BucketOwnerEnforced and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.

", "enum":[ "BucketOwnerPreferred", "ObjectWriter", @@ -7409,15 +7792,15 @@ }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" } }, "documentation":"

A container for elements related to an individual part.

" @@ -7446,7 +7829,8 @@ "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", - "SNOW" + "SNOW", + "EXPRESS_ONEZONE" ] }, "ObjectVersion":{ @@ -7542,7 +7926,7 @@ "members":{ "DisplayName":{ "shape":"DisplayName", - "documentation":"

Container for the display name of the owner. This value is only supported in the following Amazon Web Services Regions:

  • US East (N. Virginia)

  • US West (N. California)

  • US West (Oregon)

  • Asia Pacific (Singapore)

  • Asia Pacific (Sydney)

  • Asia Pacific (Tokyo)

  • Europe (Ireland)

  • South America (São Paulo)

" + "documentation":"

Container for the display name of the owner. This value is only supported in the following Amazon Web Services Regions:

  • US East (N. Virginia)

  • US West (N. California)

  • US West (Oregon)

  • Asia Pacific (Singapore)

  • Asia Pacific (Sydney)

  • Asia Pacific (Tokyo)

  • Europe (Ireland)

  • South America (São Paulo)

This functionality is not supported for directory buckets.

" }, "ID":{ "shape":"ID", @@ -7611,11 +7995,11 @@ }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" + "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", @@ -7777,13 +8161,13 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" } @@ -7821,7 +8205,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -7857,7 +8241,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -7893,7 +8277,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -7928,13 +8312,13 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -7963,7 +8347,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -7974,7 +8358,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8040,7 +8424,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8060,7 +8444,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -8072,7 +8456,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8098,7 +8482,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -8110,7 +8494,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8145,13 +8529,13 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8187,7 +8571,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8215,7 +8599,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, @@ -8250,7 +8634,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -8262,7 +8646,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8291,7 +8675,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, @@ -8313,36 +8697,36 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket.

", + "documentation":"

The name of the bucket.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"

The MD5 hash of the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", + "documentation":"

The MD5 hash of the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"Content-MD5" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:

  • CRC32

  • CRC32C

  • SHA1

  • SHA256

For more information, see Checking object integrity in the Amazon S3 User Guide.

If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, "ConfirmRemoveSelfBucketAccess":{ "shape":"ConfirmRemoveSelfBucketAccess", - "documentation":"

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

", + "documentation":"

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-confirm-remove-self-bucket-access" }, "Policy":{ "shape":"Policy", - "documentation":"

The bucket policy as a JSON document.

" + "documentation":"

The bucket policy as a JSON document.

For directory buckets, the only IAM action supported in the bucket policy is s3express:CreateSession.

" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8371,7 +8755,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -8388,7 +8772,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8417,7 +8801,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -8429,7 +8813,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8458,7 +8842,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -8470,7 +8854,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8499,7 +8883,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -8517,7 +8901,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8546,7 +8930,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -8558,7 +8942,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8596,7 +8980,7 @@ }, "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name that contains the object to which you want to attach the ACL.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "documentation":"

The bucket name that contains the object to which you want to attach the ACL.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -8609,25 +8993,25 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, "GrantFullControl":{ "shape":"GrantFullControl", - "documentation":"

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

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

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

This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-full-control" }, "GrantRead":{ "shape":"GrantRead", - "documentation":"

Allows grantee to list the objects in the bucket.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Allows grantee to list the objects in the bucket.

This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-read" }, "GrantReadACP":{ "shape":"GrantReadACP", - "documentation":"

Allows grantee to read the bucket ACL.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Allows grantee to read the bucket ACL.

This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-read-acp" }, @@ -8639,13 +9023,13 @@ }, "GrantWriteACP":{ "shape":"GrantWriteACP", - "documentation":"

Allows grantee to write the ACL for the applicable bucket.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Allows grantee to write the ACL for the applicable bucket.

This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-write-acp" }, "Key":{ "shape":"ObjectKey", - "documentation":"

Key for which the PUT action was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

Key for which the PUT action was initiated.

", "contextParam":{"name":"Key"}, "location":"uri", "locationName":"Key" @@ -8657,13 +9041,13 @@ }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

VersionId used to reference a specific version of the object.

", + "documentation":"

Version ID used to reference a specific version of the object.

This functionality is not supported for directory buckets.

", "location":"querystring", "locationName":"versionId" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8689,7 +9073,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name containing the object that you want to place a legal hold on.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "documentation":"

The bucket name containing the object that you want to place a legal hold on.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -8725,13 +9109,13 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8784,13 +9168,13 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -8802,79 +9186,79 @@ "members":{ "Expiration":{ "shape":"Expiration", - "documentation":"

If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.

", + "documentation":"

If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-expiration" }, "ETag":{ "shape":"ETag", - "documentation":"

Entity tag for the uploaded object.

", + "documentation":"

Entity tag for the uploaded object.

General purpose buckets - To ensure that data is not corrupted traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

Directory buckets - The ETag for the object in a directory bucket isn't the MD5 digest of the object.

", "location":"header", "locationName":"ETag" }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-crc32c" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-sha256" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

", + "documentation":"

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

", "location":"header", "locationName":"x-amz-server-side-encryption" }, "VersionId":{ "shape":"ObjectVersionId", - "documentation":"

Version of the object.

", + "documentation":"

Version ID of the object.

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-version-id" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"

If x-amz-server-side-encryption has a valid value of aws:kms or aws:kms:dsse, this header specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

", + "documentation":"

If x-amz-server-side-encryption has a valid value of aws:kms or aws:kms:dsse, this header indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject or CopyObject operations on this object.

", + "documentation":"

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject or CopyObject operations on this object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, "BucketKeyEnabled":{ "shape":"BucketKeyEnabled", - "documentation":"

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

", + "documentation":"

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-bucket-key-enabled" }, @@ -8894,7 +9278,7 @@ "members":{ "ACL":{ "shape":"ObjectCannedACL", - "documentation":"

The canned ACL to apply to the object. For more information, see Canned ACL.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

The canned ACL to apply to the object. For more information, see Canned ACL in the Amazon S3 User Guide.

When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide.

If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a 400 error with the error code AccessControlListNotSupported. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-acl" }, @@ -8905,14 +9289,14 @@ }, "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name to which the PUT action was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The bucket name to which the PUT action was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "CacheControl":{ "shape":"CacheControl", - "documentation":"

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

", + "documentation":"

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

", "location":"header", "locationName":"Cache-Control" }, @@ -8942,7 +9326,7 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

", + "documentation":"

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"Content-MD5" }, @@ -8954,7 +9338,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:

  • CRC32

  • CRC32C

  • SHA1

  • SHA256

For more information, see Checking object integrity in the Amazon S3 User Guide.

If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -8990,25 +9374,25 @@ }, "GrantFullControl":{ "shape":"GrantFullControl", - "documentation":"

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-full-control" }, "GrantRead":{ "shape":"GrantRead", - "documentation":"

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Allows grantee to read the object data and its metadata.

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-read" }, "GrantReadACP":{ "shape":"GrantReadACP", - "documentation":"

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Allows grantee to read the object ACL.

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-read-acp" }, "GrantWriteACP":{ "shape":"GrantWriteACP", - "documentation":"

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

", + "documentation":"

Allows grantee to write the ACL for the applicable object.

  • This functionality is not supported for directory buckets.

  • This functionality is not supported for Amazon S3 on Outposts.

", "location":"header", "locationName":"x-amz-grant-write-acp" }, @@ -9027,55 +9411,55 @@ }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

", + "documentation":"

The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.

Directory buckets - For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) value is supported.

", "location":"header", "locationName":"x-amz-server-side-encryption" }, "StorageClass":{ "shape":"StorageClass", - "documentation":"

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

", + "documentation":"

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

  • For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.

  • Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.

", "location":"header", "locationName":"x-amz-storage-class" }, "WebsiteRedirectLocation":{ "shape":"WebsiteRedirectLocation", - "documentation":"

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

", + "documentation":"

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata in the Amazon S3 User Guide.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-website-redirect-location" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

Specifies the algorithm to use to when encrypting the object (for example, AES256).

", + "documentation":"

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", - "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

", + "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

", + "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"

If x-amz-server-side-encryption has a valid value of aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data. If the KMS key does not exist in the same account that's issuing the command, you must use the full ARN and not just the ID.

", + "documentation":"

If x-amz-server-side-encryption has a valid value of aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data. If the KMS key does not exist in the same account that's issuing the command, you must use the full ARN and not just the ID.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject or CopyObject operations on this object. This value must be explicitly added during CopyObject operations.

", + "documentation":"

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject or CopyObject operations on this object. This value must be explicitly added during CopyObject operations.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, "BucketKeyEnabled":{ "shape":"BucketKeyEnabled", - "documentation":"

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

", + "documentation":"

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-bucket-key-enabled" }, @@ -9086,31 +9470,31 @@ }, "Tagging":{ "shape":"TaggingHeader", - "documentation":"

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, \"Key1=Value1\")

", + "documentation":"

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, \"Key1=Value1\")

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-tagging" }, "ObjectLockMode":{ "shape":"ObjectLockMode", - "documentation":"

The Object Lock mode that you want to apply to this object.

", + "documentation":"

The Object Lock mode that you want to apply to this object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-mode" }, "ObjectLockRetainUntilDate":{ "shape":"ObjectLockRetainUntilDate", - "documentation":"

The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.

", + "documentation":"

The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-retain-until-date" }, "ObjectLockLegalHoldStatus":{ "shape":"ObjectLockLegalHoldStatus", - "documentation":"

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

", + "documentation":"

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-object-lock-legal-hold" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -9136,7 +9520,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name that contains the object you want to apply this Object Retention configuration to.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "documentation":"

The bucket name that contains the object you want to apply this Object Retention configuration to.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -9178,13 +9562,13 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -9212,7 +9596,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The bucket name containing the object.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -9237,7 +9621,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9249,7 +9633,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, @@ -9283,7 +9667,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9295,7 +9679,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -9418,6 +9802,11 @@ }, "documentation":"

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

" }, + "Region":{ + "type":"string", + "max":20, + "min":0 + }, "ReplaceKeyPrefixWith":{"type":"string"}, "ReplaceKeyWith":{"type":"string"}, "ReplicaKmsKeyID":{"type":"string"}, @@ -9592,12 +9981,12 @@ }, "RequestCharged":{ "type":"string", - "documentation":"

If present, indicates that the requester was successfully charged for the request.

", + "documentation":"

If present, indicates that the requester was successfully charged for the request.

This functionality is not supported for directory buckets.

", "enum":["requester"] }, "RequestPayer":{ "type":"string", - "documentation":"

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

", + "documentation":"

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

", "enum":["requester"] }, "RequestPaymentConfiguration":{ @@ -9659,7 +10048,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name containing the object to restore.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The bucket name containing the object to restore.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -9688,13 +10077,13 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -9752,7 +10141,7 @@ "documentation":"

Indicates when the restored copy will expire. This value is populated only if the object has already been restored. For example:

x-amz-optional-object-attributes: IsRestoreInProgress=\"false\", RestoreExpiryDate=\"2012-12-21T00:00:00.000Z\"

" } }, - "documentation":"

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

" + "documentation":"

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

" }, "Role":{"type":"string"}, "RoutingRule":{ @@ -10016,7 +10405,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -10105,6 +10494,50 @@ "member":{"shape":"ServerSideEncryptionRule"}, "flattened":true }, + "SessionCredentialValue":{ + "type":"string", + "sensitive":true + }, + "SessionCredentials":{ + "type":"structure", + "required":[ + "AccessKeyId", + "SecretAccessKey", + "SessionToken", + "Expiration" + ], + "members":{ + "AccessKeyId":{ + "shape":"AccessKeyIdValue", + "documentation":"

A unique identifier that's associated with a secret access key. The access key ID and the secret access key are used together to sign programmatic Amazon Web Services requests cryptographically.

", + "locationName":"AccessKeyId" + }, + "SecretAccessKey":{ + "shape":"SessionCredentialValue", + "documentation":"

A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services requests. Signing a request identifies the sender and prevents the request from being altered.

", + "locationName":"SecretAccessKey" + }, + "SessionToken":{ + "shape":"SessionCredentialValue", + "documentation":"

A part of the temporary security credentials. The session token is used to validate the temporary security credentials.

", + "locationName":"SessionToken" + }, + "Expiration":{ + "shape":"SessionExpiration", + "documentation":"

Temporary security credentials expire after a specified interval. After temporary credentials expire, any calls that you make with those credentials will fail. So you must generate a new set of temporary credentials. Temporary credentials cannot be extended or refreshed beyond the original specified interval.

", + "locationName":"Expiration" + } + }, + "documentation":"

The established temporary security credentials of the session.

Directory buckets - These session credentials are only supported for the authentication and authorization of Zonal endpoint APIs on directory buckets.

" + }, + "SessionExpiration":{"type":"timestamp"}, + "SessionMode":{ + "type":"string", + "enum":[ + "ReadOnly", + "ReadWrite" + ] + }, "Setting":{ "type":"boolean", "box":true @@ -10203,7 +10636,8 @@ "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", - "SNOW" + "SNOW", + "EXPRESS_ONEZONE" ] }, "StorageClassAnalysis":{ @@ -10456,7 +10890,7 @@ "members":{ "CopySourceVersionId":{ "shape":"CopySourceVersionId", - "documentation":"

The version of the source object that was copied, if you have enabled versioning on the source bucket.

", + "documentation":"

The version of the source object that was copied, if you have enabled versioning on the source bucket.

This functionality is not supported when the source object is in a directory bucket.

", "location":"header", "locationName":"x-amz-copy-source-version-id" }, @@ -10466,31 +10900,31 @@ }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

", + "documentation":"

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

", "location":"header", "locationName":"x-amz-server-side-encryption" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

", + "documentation":"

If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "BucketKeyEnabled":{ "shape":"BucketKeyEnabled", - "documentation":"

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

", + "documentation":"

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-bucket-key-enabled" }, @@ -10514,38 +10948,38 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket name.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The bucket name.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "CopySource":{ "shape":"CopySource", - "documentation":"

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf 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/object/reports/january.pdf. The value must be URL-encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

", + "documentation":"

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    • Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.

    • Access points are not supported by directory buckets.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf 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/object/reports/january.pdf. The value must be URL-encoded.

If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the source object to copy. To copy a specific version of the source object to copy, append ?versionId=<version-id> to the x-amz-copy-source request header (for example, x-amz-copy-source: /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).

If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source request header, Amazon S3 returns a 404 Not Found error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 Bad Request error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source.

Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.

", "location":"header", "locationName":"x-amz-copy-source" }, "CopySourceIfMatch":{ "shape":"CopySourceIfMatch", - "documentation":"

Copies the object if its entity tag (ETag) matches the specified tag.

", + "documentation":"

Copies the object if its entity tag (ETag) matches the specified tag.

If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows:

x-amz-copy-source-if-match condition evaluates to true, and;

x-amz-copy-source-if-unmodified-since condition evaluates to false;

Amazon S3 returns 200 OK and copies the data.

", "location":"header", "locationName":"x-amz-copy-source-if-match" }, "CopySourceIfModifiedSince":{ "shape":"CopySourceIfModifiedSince", - "documentation":"

Copies the object if it has been modified since the specified time.

", + "documentation":"

Copies the object if it has been modified since the specified time.

If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows:

x-amz-copy-source-if-none-match condition evaluates to false, and;

x-amz-copy-source-if-modified-since condition evaluates to true;

Amazon S3 returns 412 Precondition Failed response code.

", "location":"header", "locationName":"x-amz-copy-source-if-modified-since" }, "CopySourceIfNoneMatch":{ "shape":"CopySourceIfNoneMatch", - "documentation":"

Copies the object if its entity tag (ETag) is different than the specified ETag.

", + "documentation":"

Copies the object if its entity tag (ETag) is different than the specified ETag.

If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows:

x-amz-copy-source-if-none-match condition evaluates to false, and;

x-amz-copy-source-if-modified-since condition evaluates to true;

Amazon S3 returns 412 Precondition Failed response code.

", "location":"header", "locationName":"x-amz-copy-source-if-none-match" }, "CopySourceIfUnmodifiedSince":{ "shape":"CopySourceIfUnmodifiedSince", - "documentation":"

Copies the object if it hasn't been modified since the specified time.

", + "documentation":"

Copies the object if it hasn't been modified since the specified time.

If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows:

x-amz-copy-source-if-match condition evaluates to true, and;

x-amz-copy-source-if-unmodified-since condition evaluates to false;

Amazon S3 returns 200 OK and copies the data.

", "location":"header", "locationName":"x-amz-copy-source-if-unmodified-since" }, @@ -10575,37 +11009,37 @@ }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

Specifies the algorithm to use to when encrypting the object (for example, AES256).

", + "documentation":"

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported when the destination bucket is a directory bucket.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", - "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

", + "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

This functionality is not supported when the destination bucket is a directory bucket.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

", + "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

This functionality is not supported when the destination bucket is a directory bucket.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "CopySourceSSECustomerAlgorithm":{ "shape":"CopySourceSSECustomerAlgorithm", - "documentation":"

Specifies the algorithm to use when decrypting the source object (for example, AES256).

", + "documentation":"

Specifies the algorithm to use when decrypting the source object (for example, AES256).

This functionality is not supported when the source object is in a directory bucket.

", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm" }, "CopySourceSSECustomerKey":{ "shape":"CopySourceSSECustomerKey", - "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

", + "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

This functionality is not supported when the source object is in a directory bucket.

", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-key" }, "CopySourceSSECustomerKeyMD5":{ "shape":"CopySourceSSECustomerKeyMD5", - "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

", + "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

This functionality is not supported when the source object is in a directory bucket.

", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5" }, @@ -10616,13 +11050,13 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" }, "ExpectedSourceBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-source-expected-bucket-owner" } @@ -10633,7 +11067,7 @@ "members":{ "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

", + "documentation":"

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

", "location":"header", "locationName":"x-amz-server-side-encryption" }, @@ -10645,49 +11079,49 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-crc32c" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", + "documentation":"

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

", "location":"header", "locationName":"x-amz-checksum-sha256" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

", + "documentation":"

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key was used for the object.

", + "documentation":"

If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "BucketKeyEnabled":{ "shape":"BucketKeyEnabled", - "documentation":"

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

", + "documentation":"

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-bucket-key-enabled" }, @@ -10714,7 +11148,7 @@ }, "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket to which the multipart upload was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "documentation":"

The name of the bucket to which the multipart upload was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -10727,13 +11161,13 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

", + "documentation":"

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"Content-MD5" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

", + "documentation":"

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -10782,19 +11216,19 @@ }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", - "documentation":"

Specifies the algorithm to use to when encrypting the object (for example, AES256).

", + "documentation":"

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", - "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

", + "documentation":"

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", - "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

", + "documentation":"

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

This functionality is not supported for directory buckets.

", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, @@ -10805,7 +11239,7 @@ }, "ExpectedBucketOwner":{ "shape":"AccountId", - "documentation":"

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", + "documentation":"

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "location":"header", "locationName":"x-amz-expected-bucket-owner" } @@ -11127,6 +11561,10 @@ "documentation":"Disables this client's usage of Multi-Region Access Points.", "type":"boolean" }, + "DisableS3ExpressSessionAuth":{ + "documentation":"Disables this client's usage of Session Auth for S3Express\n buckets and reverts to using conventional SigV4 for those.", + "type":"boolean" + }, "ForcePathStyle":{ "documentation":"Forces this client to use path-style addressing for buckets.", "type":"boolean" diff --git a/botocore/data/s3control/2018-08-20/service-2.json b/botocore/data/s3control/2018-08-20/service-2.json index 853b1d4649..1e19a3a2b0 100644 --- a/botocore/data/s3control/2018-08-20/service-2.json +++ b/botocore/data/s3control/2018-08-20/service-2.json @@ -106,7 +106,7 @@ "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, "output":{"shape":"CreateAccessPointResult"}, - "documentation":"

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.

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.

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:

", + "documentation":"

This operation is not supported by directory buckets.

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.

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.

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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -126,7 +126,7 @@ "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, "output":{"shape":"CreateAccessPointForObjectLambdaResult"}, - "documentation":"

Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.

The following actions are related to CreateAccessPointForObjectLambda:

", + "documentation":"

This operation is not supported by directory buckets.

Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.

The following actions are related to CreateAccessPointForObjectLambda:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -167,7 +167,7 @@ {"shape":"IdempotencyException"}, {"shape":"InternalServiceException"} ], - "documentation":"

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 in the Amazon S3 User Guide.

This action creates a S3 Batch Operations job.

Related actions include:

", + "documentation":"

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 in the Amazon S3 User Guide.

Permissions

For information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -187,7 +187,7 @@ "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, "output":{"shape":"CreateMultiRegionAccessPointResult"}, - "documentation":"

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points 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:

", + "documentation":"

This operation is not supported by directory buckets.

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points 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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -287,7 +287,7 @@ "requestUri":"/v20180820/accesspoint/{name}" }, "input":{"shape":"DeleteAccessPointRequest"}, - "documentation":"

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:

", + "documentation":"

This operation is not supported by directory buckets.

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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -302,7 +302,7 @@ "requestUri":"/v20180820/accesspointforobjectlambda/{name}" }, "input":{"shape":"DeleteAccessPointForObjectLambdaRequest"}, - "documentation":"

Deletes the specified Object Lambda Access Point.

The following actions are related to DeleteAccessPointForObjectLambda:

", + "documentation":"

This operation is not supported by directory buckets.

Deletes the specified Object Lambda Access Point.

The following actions are related to DeleteAccessPointForObjectLambda:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -317,7 +317,7 @@ "requestUri":"/v20180820/accesspoint/{name}/policy" }, "input":{"shape":"DeleteAccessPointPolicyRequest"}, - "documentation":"

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:

", + "documentation":"

This operation is not supported by directory buckets.

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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -332,7 +332,7 @@ "requestUri":"/v20180820/accesspointforobjectlambda/{name}/policy" }, "input":{"shape":"DeleteAccessPointPolicyForObjectLambdaRequest"}, - "documentation":"

Removes the resource policy for an Object Lambda Access Point.

The following actions are related to DeleteAccessPointPolicyForObjectLambda:

", + "documentation":"

This operation is not supported by directory buckets.

Removes the resource policy for an Object Lambda Access Point.

The following actions are related to DeleteAccessPointPolicyForObjectLambda:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -429,7 +429,7 @@ {"shape":"TooManyRequestsException"}, {"shape":"NotFoundException"} ], - "documentation":"

Removes the entire tag set from the specified S3 Batch Operations job. 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 in the Amazon S3 User Guide.

Related actions include:

", + "documentation":"

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 in the Amazon S3 User Guide.

Related actions include:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -449,7 +449,7 @@ "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, "output":{"shape":"DeleteMultiRegionAccessPointResult"}, - "documentation":"

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points 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:

", + "documentation":"

This operation is not supported by directory buckets.

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points 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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -465,7 +465,7 @@ "requestUri":"/v20180820/configuration/publicAccessBlock" }, "input":{"shape":"DeletePublicAccessBlockRequest"}, - "documentation":"

Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

", + "documentation":"

This operation is not supported by directory buckets.

Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -480,7 +480,7 @@ "requestUri":"/v20180820/storagelens/{storagelensid}" }, "input":{"shape":"DeleteStorageLensConfigurationRequest"}, - "documentation":"

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 in the Amazon S3 User Guide.

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 in the Amazon S3 User Guide.

", + "documentation":"

This operation is not supported by directory buckets.

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 in the Amazon S3 User Guide.

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 in the Amazon S3 User Guide.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -496,7 +496,7 @@ }, "input":{"shape":"DeleteStorageLensConfigurationTaggingRequest"}, "output":{"shape":"DeleteStorageLensConfigurationTaggingResult"}, - "documentation":"

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 in the Amazon S3 User Guide.

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.

", + "documentation":"

This operation is not supported by directory buckets.

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 in the Amazon S3 User Guide.

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.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -534,7 +534,7 @@ {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], - "documentation":"

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

Related actions include:

", + "documentation":"

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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -550,7 +550,7 @@ }, "input":{"shape":"DescribeMultiRegionAccessPointOperationRequest"}, "output":{"shape":"DescribeMultiRegionAccessPointOperationResult"}, - "documentation":"

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 Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

", + "documentation":"

This operation is not supported by directory buckets.

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 Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -668,7 +668,7 @@ }, "input":{"shape":"GetAccessPointRequest"}, "output":{"shape":"GetAccessPointResult"}, - "documentation":"

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:

", + "documentation":"

This operation is not supported by directory buckets.

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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -684,7 +684,7 @@ }, "input":{"shape":"GetAccessPointConfigurationForObjectLambdaRequest"}, "output":{"shape":"GetAccessPointConfigurationForObjectLambdaResult"}, - "documentation":"

Returns configuration for an Object Lambda Access Point.

The following actions are related to GetAccessPointConfigurationForObjectLambda:

", + "documentation":"

This operation is not supported by directory buckets.

Returns configuration for an Object Lambda Access Point.

The following actions are related to GetAccessPointConfigurationForObjectLambda:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -700,7 +700,7 @@ }, "input":{"shape":"GetAccessPointForObjectLambdaRequest"}, "output":{"shape":"GetAccessPointForObjectLambdaResult"}, - "documentation":"

Returns configuration information about the specified Object Lambda Access Point

The following actions are related to GetAccessPointForObjectLambda:

", + "documentation":"

This operation is not supported by directory buckets.

Returns configuration information about the specified Object Lambda Access Point

The following actions are related to GetAccessPointForObjectLambda:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -716,7 +716,7 @@ }, "input":{"shape":"GetAccessPointPolicyRequest"}, "output":{"shape":"GetAccessPointPolicyResult"}, - "documentation":"

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

The following actions are related to GetAccessPointPolicy:

", + "documentation":"

This operation is not supported by directory buckets.

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

The following actions are related to GetAccessPointPolicy:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -732,7 +732,7 @@ }, "input":{"shape":"GetAccessPointPolicyForObjectLambdaRequest"}, "output":{"shape":"GetAccessPointPolicyForObjectLambdaResult"}, - "documentation":"

Returns the resource policy for an Object Lambda Access Point.

The following actions are related to GetAccessPointPolicyForObjectLambda:

", + "documentation":"

This operation is not supported by directory buckets.

Returns the resource policy for an Object Lambda Access Point.

The following actions are related to GetAccessPointPolicyForObjectLambda:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -748,7 +748,7 @@ }, "input":{"shape":"GetAccessPointPolicyStatusRequest"}, "output":{"shape":"GetAccessPointPolicyStatusResult"}, - "documentation":"

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.

", + "documentation":"

This operation is not supported by directory buckets.

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.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -764,7 +764,7 @@ }, "input":{"shape":"GetAccessPointPolicyStatusForObjectLambdaRequest"}, "output":{"shape":"GetAccessPointPolicyStatusForObjectLambdaResult"}, - "documentation":"

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

", + "documentation":"

This operation is not supported by directory buckets.

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

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -780,7 +780,7 @@ }, "input":{"shape":"GetBucketRequest"}, "output":{"shape":"GetBucketResult"}, - "documentation":"

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.

", + "documentation":"

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.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -898,7 +898,7 @@ {"shape":"TooManyRequestsException"}, {"shape":"NotFoundException"} ], - "documentation":"

Returns the tags on an S3 Batch Operations job. 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 in the Amazon S3 User Guide.

Related actions include:

", + "documentation":"

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 in the Amazon S3 User Guide.

Related actions include:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -914,7 +914,7 @@ }, "input":{"shape":"GetMultiRegionAccessPointRequest"}, "output":{"shape":"GetMultiRegionAccessPointResult"}, - "documentation":"

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

", + "documentation":"

This operation is not supported by directory buckets.

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -931,7 +931,7 @@ }, "input":{"shape":"GetMultiRegionAccessPointPolicyRequest"}, "output":{"shape":"GetMultiRegionAccessPointPolicyResult"}, - "documentation":"

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPointPolicy:

", + "documentation":"

This operation is not supported by directory buckets.

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPointPolicy:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -948,7 +948,7 @@ }, "input":{"shape":"GetMultiRegionAccessPointPolicyStatusRequest"}, "output":{"shape":"GetMultiRegionAccessPointPolicyStatusResult"}, - "documentation":"

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPointPolicyStatus:

", + "documentation":"

This operation is not supported by directory buckets.

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPointPolicyStatus:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -965,7 +965,7 @@ }, "input":{"shape":"GetMultiRegionAccessPointRoutesRequest"}, "output":{"shape":"GetMultiRegionAccessPointRoutesResult"}, - "documentation":"

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

Your Amazon S3 bucket does not need to be in these five Regions.

", + "documentation":"

This operation is not supported by directory buckets.

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

Your Amazon S3 bucket does not need to be in these five Regions.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -985,7 +985,7 @@ "errors":[ {"shape":"NoSuchPublicAccessBlockConfiguration"} ], - "documentation":"

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

", + "documentation":"

This operation is not supported by directory buckets.

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1001,7 +1001,7 @@ }, "input":{"shape":"GetStorageLensConfigurationRequest"}, "output":{"shape":"GetStorageLensConfigurationResult"}, - "documentation":"

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage 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.

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 in the Amazon S3 User Guide.

", + "documentation":"

This operation is not supported by directory buckets.

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage 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.

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 in the Amazon S3 User Guide.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1017,7 +1017,7 @@ }, "input":{"shape":"GetStorageLensConfigurationTaggingRequest"}, "output":{"shape":"GetStorageLensConfigurationTaggingResult"}, - "documentation":"

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 in the Amazon S3 User Guide.

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.

", + "documentation":"

This operation is not supported by directory buckets.

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 in the Amazon S3 User Guide.

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.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1100,7 +1100,7 @@ }, "input":{"shape":"ListAccessPointsRequest"}, "output":{"shape":"ListAccessPointsResult"}, - "documentation":"

Returns a list of the access points that are owned by the current account that's associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has 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.

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:

", + "documentation":"

This operation is not supported by directory buckets.

Returns a list of the access points that are owned by the current account that's associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has 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.

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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1116,7 +1116,7 @@ }, "input":{"shape":"ListAccessPointsForObjectLambdaRequest"}, "output":{"shape":"ListAccessPointsForObjectLambdaResult"}, - "documentation":"

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:

", + "documentation":"

This operation is not supported by directory buckets.

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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1137,7 +1137,7 @@ {"shape":"InternalServiceException"}, {"shape":"InvalidNextTokenException"} ], - "documentation":"

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

", + "documentation":"

Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 30 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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1153,7 +1153,7 @@ }, "input":{"shape":"ListMultiRegionAccessPointsRequest"}, "output":{"shape":"ListMultiRegionAccessPointsResult"}, - "documentation":"

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to ListMultiRegionAccessPoint:

", + "documentation":"

This operation is not supported by directory buckets.

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to ListMultiRegionAccessPoint:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1170,7 +1170,7 @@ }, "input":{"shape":"ListRegionalBucketsRequest"}, "output":{"shape":"ListRegionalBucketsResult"}, - "documentation":"

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 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.

", + "documentation":"

This operation is not supported by directory buckets.

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 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.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1186,7 +1186,7 @@ }, "input":{"shape":"ListStorageLensConfigurationsRequest"}, "output":{"shape":"ListStorageLensConfigurationsResult"}, - "documentation":"

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 in the Amazon S3 User Guide.

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 in the Amazon S3 User Guide.

", + "documentation":"

This operation is not supported by directory buckets.

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 in the Amazon S3 User Guide.

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 in the Amazon S3 User Guide.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1258,7 +1258,7 @@ "locationName":"PutAccessPointConfigurationForObjectLambdaRequest", "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, - "documentation":"

Replaces configuration for an Object Lambda Access Point.

The following actions are related to PutAccessPointConfigurationForObjectLambda:

", + "documentation":"

This operation is not supported by directory buckets.

Replaces configuration for an Object Lambda Access Point.

The following actions are related to PutAccessPointConfigurationForObjectLambda:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1277,7 +1277,7 @@ "locationName":"PutAccessPointPolicyRequest", "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, - "documentation":"

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:

", + "documentation":"

This operation is not supported by directory buckets.

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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1296,7 +1296,7 @@ "locationName":"PutAccessPointPolicyForObjectLambdaRequest", "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, - "documentation":"

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:

", + "documentation":"

This operation is not supported by directory buckets.

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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1406,7 +1406,7 @@ {"shape":"NotFoundException"}, {"shape":"TooManyTagsException"} ], - "documentation":"

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 action 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.

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

  • For deleting existing tags for your Batch Operations job, a DeleteJobTagging 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.

To use the PutJobTagging operation, you must have permission to perform the s3:PutJobTagging action.

Related actions include:

", + "documentation":"

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.

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

  • For deleting existing tags for your Batch Operations job, a DeleteJobTagging 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.
Permissions

To use the PutJobTagging operation, you must have permission to perform the s3:PutJobTagging action.

Related actions include:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1426,7 +1426,7 @@ "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, "output":{"shape":"PutMultiRegionAccessPointPolicyResult"}, - "documentation":"

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to PutMultiRegionAccessPointPolicy:

", + "documentation":"

This operation is not supported by directory buckets.

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 managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to PutMultiRegionAccessPointPolicy:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1442,7 +1442,7 @@ "requestUri":"/v20180820/configuration/publicAccessBlock" }, "input":{"shape":"PutPublicAccessBlockRequest"}, - "documentation":"

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutAccountPublicAccessBlock permission. For more information, see Using Amazon S3 block public access.

Related actions include:

", + "documentation":"

This operation is not supported by directory buckets.

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutAccountPublicAccessBlock permission. For more information, see Using Amazon S3 block public access.

Related actions include:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1461,7 +1461,7 @@ "locationName":"PutStorageLensConfigurationRequest", "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, - "documentation":"

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.

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 in the Amazon S3 User Guide.

", + "documentation":"

This operation is not supported by directory buckets.

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.

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 in the Amazon S3 User Guide.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1481,7 +1481,7 @@ "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, "output":{"shape":"PutStorageLensConfigurationTaggingResult"}, - "documentation":"

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 in the Amazon S3 User Guide.

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.

", + "documentation":"

This operation is not supported by directory buckets.

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 in the Amazon S3 User Guide.

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.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1501,7 +1501,7 @@ "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, "output":{"shape":"SubmitMultiRegionAccessPointRoutesResult"}, - "documentation":"

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.

Updated routing configurations might not be immediately applied. It can take up to 2 minutes for your changes to take effect.

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

Your Amazon S3 bucket does not need to be in these five Regions.

", + "documentation":"

This operation is not supported by directory buckets.

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.

Updated routing configurations might not be immediately applied. It can take up to 2 minutes for your changes to take effect.

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

Your Amazon S3 bucket does not need to be in these five Regions.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1583,7 +1583,7 @@ {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

", + "documentation":"

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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -1606,7 +1606,7 @@ {"shape":"JobStatusException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Updates the status for the specified job. Use this action 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.

Related actions include:

", + "documentation":"

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:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -3226,7 +3226,7 @@ }, "StorageClass":{ "shape":"ReplicationStorageClass", - "documentation":"

The storage class to use when replicating objects. All objects stored on S3 on Outposts are stored in the OUTPOSTS storage class. S3 on Outposts uses the OUTPOSTS storage class to create the object replicas.

Values other than OUTPOSTS are not supported by Amazon S3 on Outposts.

" + "documentation":"

The storage class to use when replicating objects. All objects stored on S3 on Outposts are stored in the OUTPOSTS storage class. S3 on Outposts uses the OUTPOSTS storage class to create the object replicas.

Values other than OUTPOSTS aren't supported by Amazon S3 on Outposts.

" } }, "documentation":"

Specifies information about the replication destination bucket and its settings for an S3 on Outposts replication configuration.

" @@ -4692,7 +4692,7 @@ }, "Location":{ "shape":"JobManifestLocation", - "documentation":"

Contains the information required to locate the specified job's manifest.

" + "documentation":"

Contains the information required to locate the specified job's manifest. Manifests can't be imported from directory buckets. For more information, see Directory buckets.

" } }, "documentation":"

Contains the configuration information for a job's manifest.

" @@ -4790,7 +4790,7 @@ "documentation":"

The ETag for the specified manifest object.

" } }, - "documentation":"

Contains the information required to locate a manifest object.

" + "documentation":"

Contains the information required to locate a manifest object. Manifests can't be imported from directory buckets. For more information, see Directory buckets.

" }, "JobManifestSpec":{ "type":"structure", @@ -4831,22 +4831,22 @@ }, "S3PutObjectAcl":{ "shape":"S3SetObjectAclOperation", - "documentation":"

Directs the specified job to run a PutObjectAcl call on every object in the manifest.

", + "documentation":"

Directs the specified job to run a PutObjectAcl call on every object in the manifest.

This functionality is not supported by directory buckets.

", "box":true }, "S3PutObjectTagging":{ "shape":"S3SetObjectTaggingOperation", - "documentation":"

Directs the specified job to run a PUT Object tagging call on every object in the manifest.

", + "documentation":"

Directs the specified job to run a PUT Object tagging call on every object in the manifest.

This functionality is not supported by directory buckets.

", "box":true }, "S3DeleteObjectTagging":{ "shape":"S3DeleteObjectTaggingOperation", - "documentation":"

Directs the specified job to execute a DELETE Object tagging call on every object in the manifest.

", + "documentation":"

Directs the specified job to execute a DELETE Object tagging call on every object in the manifest.

This functionality is not supported by directory buckets.

", "box":true }, "S3InitiateRestoreObject":{ "shape":"S3InitiateRestoreObjectOperation", - "documentation":"

Directs the specified job to initiate restore requests for every archived object in the manifest.

", + "documentation":"

Directs the specified job to initiate restore requests for every archived object in the manifest.

This functionality is not supported by directory buckets.

", "box":true }, "S3PutObjectLegalHold":{ @@ -4859,7 +4859,7 @@ }, "S3ReplicateObject":{ "shape":"S3ReplicateObjectOperation", - "documentation":"

Directs the specified job to invoke ReplicateObject on every object in the job's manifest.

", + "documentation":"

Directs the specified job to invoke ReplicateObject on every object in the job's manifest.

This functionality is not supported by directory buckets.

", "box":true } }, @@ -4901,7 +4901,7 @@ "members":{ "Bucket":{ "shape":"S3BucketArnString", - "documentation":"

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

", + "documentation":"

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Directory buckets - Directory buckets aren't supported as a location for Batch Operations to store job completion reports.

", "box":true }, "Format":{ @@ -5021,6 +5021,14 @@ "FunctionArn":{ "shape":"FunctionArnString", "documentation":"

The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the manifest.

" + }, + "InvocationSchemaVersion":{ + "shape":"NonEmptyMaxLength64String", + "documentation":"

Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda function. Version 1.0 is the default. Version 2.0 is required when you use Batch Operations to invoke Lambda functions that act on directory buckets, or if you need to specify UserArguments. For more information, see Using Lambda with Amazon S3 Batch Operations and Amazon S3 Express One Zone in the Amazon Web Services Storage Blog.

Ensure that your Lambda function code expects InvocationSchemaVersion 2.0 and uses bucket name rather than bucket ARN. If the InvocationSchemaVersion does not match what your Lambda function expects, your function might not work as expected.

Directory buckets - To initiate Amazon Web Services Lambda function to perform custom actions on objects in directory buckets, you must specify 2.0.

" + }, + "UserArguments":{ + "shape":"UserArguments", + "documentation":"

Key-value pairs that are passed in the payload that Batch Operations sends when invoking an Lambda function. You must specify InvocationSchemaVersion 2.0 for LambdaInvoke operations that include UserArguments. For more information, see Using Lambda with Amazon S3 Batch Operations and Amazon S3 Express One Zone in the Amazon Web Services Storage Blog.

" } }, "documentation":"

Contains the configuration parameters for a Lambda Invoke operation.

" @@ -7270,17 +7278,17 @@ "type":"structure", "members":{ "TargetResource":{ - "shape":"S3BucketArnString", - "documentation":"

Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation. For example, to copy objects to a bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.

" + "shape":"S3RegionalOrS3ExpressBucketArnString", + "documentation":"

Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.

  • General purpose buckets - For example, to copy objects to a general purpose bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.

  • Directory buckets - For example, to copy objects to a directory bucket named destinationBucket in the Availability Zone; identified by the AZ ID usw2-az2, set the TargetResource property to arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az2--x-s3.

" }, "CannedAccessControlList":{ "shape":"S3CannedAccessControlList", - "documentation":"

", + "documentation":"

This functionality is not supported by directory buckets.

", "box":true }, "AccessControlGrants":{ "shape":"S3GrantList", - "documentation":"

", + "documentation":"

This functionality is not supported by directory buckets.

", "box":true }, "MetadataDirective":{ @@ -7297,19 +7305,19 @@ }, "NewObjectTagging":{ "shape":"S3TagSet", - "documentation":"

" + "documentation":"

Specifies a list of tags to add to the destination objects after they are copied. If NewObjectTagging is not specified, the tags of the source objects are copied to destination objects by default.

Directory buckets - Tags aren't supported by directory buckets. If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the NewObjectTagging field to prevent copying the source object tags to the directory bucket.

" }, "RedirectLocation":{ "shape":"NonEmptyMaxLength2048String", - "documentation":"

Specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object is accessed through a website endpoint.

" + "documentation":"

If the destination bucket is configured as a website, specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object copy is accessed through a website endpoint.

This functionality is not supported by directory buckets.

" }, "RequesterPays":{ "shape":"Boolean", - "documentation":"

" + "documentation":"

This functionality is not supported by directory buckets.

" }, "StorageClass":{ "shape":"S3StorageClass", - "documentation":"

" + "documentation":"

Specify the storage class for the destination objects in a Copy operation.

Directory buckets - This functionality is not supported by directory buckets.

" }, "UnModifiedSinceConstraint":{ "shape":"TimeStamp", @@ -7317,7 +7325,7 @@ }, "SSEAwsKmsKeyId":{ "shape":"KmsKeyArnString", - "documentation":"

" + "documentation":"

This functionality is not supported by directory buckets.

" }, "TargetKeyPrefix":{ "shape":"NonEmptyMaxLength1024String", @@ -7325,19 +7333,19 @@ }, "ObjectLockLegalHoldStatus":{ "shape":"S3ObjectLockLegalHoldStatus", - "documentation":"

The legal hold status to be applied to all objects in the Batch Operations job.

" + "documentation":"

The legal hold status to be applied to all objects in the Batch Operations job.

This functionality is not supported by directory buckets.

" }, "ObjectLockMode":{ "shape":"S3ObjectLockMode", - "documentation":"

The retention mode to be applied to all objects in the Batch Operations job.

" + "documentation":"

The retention mode to be applied to all objects in the Batch Operations job.

This functionality is not supported by directory buckets.

" }, "ObjectLockRetainUntilDate":{ "shape":"TimeStamp", - "documentation":"

The date when the applied object retention configuration expires on all objects in the Batch Operations job.

" + "documentation":"

The date when the applied object retention configuration expires on all objects in the Batch Operations job.

This functionality is not supported by directory buckets.

" }, "BucketKeyEnabled":{ "shape":"Boolean", - "documentation":"

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

" + "documentation":"

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

This functionality is not supported by directory buckets.

" }, "ChecksumAlgorithm":{ "shape":"S3ChecksumAlgorithm", @@ -7447,15 +7455,15 @@ }, "SourceBucket":{ "shape":"S3BucketArnString", - "documentation":"

The source bucket used by the ManifestGenerator.

" + "documentation":"

The source bucket used by the ManifestGenerator.

Directory buckets - Directory buckets aren't supported as the source buckets used by S3JobManifestGenerator to generate the job manifest.

" }, "ManifestOutputLocation":{ "shape":"S3ManifestOutputLocation", - "documentation":"

Specifies the location the generated manifest will be written to.

" + "documentation":"

Specifies the location the generated manifest will be written to. Manifests can't be written to directory buckets. For more information, see Directory buckets.

" }, "Filter":{ "shape":"JobManifestGeneratorFilter", - "documentation":"

Specifies rules the S3JobManifestGenerator should use to use to decide whether an object in the source bucket should or should not be included in the generated job manifest.

" + "documentation":"

Specifies rules the S3JobManifestGenerator should use to decide whether an object in the source bucket should or should not be included in the generated job manifest.

" }, "EnableManifestOutput":{ "shape":"Boolean", @@ -7483,7 +7491,7 @@ }, "Bucket":{ "shape":"S3BucketArnString", - "documentation":"

The bucket ARN the generated manifest should be written to.

" + "documentation":"

The bucket ARN the generated manifest should be written to.

Directory buckets - Directory buckets aren't supported as the buckets to store the generated manifest.

" }, "ManifestPrefix":{ "shape":"ManifestPrefixString", @@ -7564,12 +7572,12 @@ }, "ContentLength":{ "shape":"S3ContentLength", - "documentation":"

", + "documentation":"

This member has been deprecated.

", "box":true }, "ContentMD5":{ "shape":"NonEmptyMaxLength1024String", - "documentation":"

" + "documentation":"

This member has been deprecated.

" }, "ContentType":{ "shape":"NonEmptyMaxLength1024String", @@ -7581,11 +7589,11 @@ }, "RequesterCharged":{ "shape":"Boolean", - "documentation":"

" + "documentation":"

This member has been deprecated.

" }, "SSEAlgorithm":{ "shape":"S3SSEAlgorithm", - "documentation":"

" + "documentation":"

For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

" } }, "documentation":"

" @@ -7634,6 +7642,12 @@ "max":128, "min":4 }, + "S3RegionalOrS3ExpressBucketArnString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:[^:]+:(s3|s3express):.*" + }, "S3ReplicateObjectOperation":{ "type":"structure", "members":{ @@ -7685,7 +7699,7 @@ "documentation":"

Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

" } }, - "documentation":"

Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes to every object to the underlying PutObjectLegalHold API operation. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon S3 User Guide.

" + "documentation":"

Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes to every object to the underlying PutObjectLegalHold API operation. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon S3 User Guide.

This functionality is not supported by directory buckets.

" }, "S3SetObjectRetentionOperation":{ "type":"structure", @@ -7701,7 +7715,7 @@ "documentation":"

Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

" } }, - "documentation":"

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API operation. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

" + "documentation":"

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API operation. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

This functionality is not supported by directory buckets.

" }, "S3SetObjectTaggingOperation":{ "type":"structure", @@ -8561,6 +8575,13 @@ } } }, + "UserArguments":{ + "type":"map", + "key":{"shape":"NonEmptyMaxLength64String"}, + "value":{"shape":"MaxLength1024String"}, + "max":10, + "min":1 + }, "VersioningConfiguration":{ "type":"structure", "members":{ diff --git a/tests/functional/endpoint-rules/bedrock-agent-runtime/endpoint-tests-1.json b/tests/functional/endpoint-rules/bedrock-agent-runtime/endpoint-tests-1.json new file mode 100644 index 0000000000..acf526dda4 --- /dev/null +++ b/tests/functional/endpoint-rules/bedrock-agent-runtime/endpoint-tests-1.json @@ -0,0 +1,314 @@ +{ + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/tests/functional/endpoint-rules/bedrock-agent/endpoint-tests-1.json b/tests/functional/endpoint-rules/bedrock-agent/endpoint-tests-1.json new file mode 100644 index 0000000000..b1ef7a03ee --- /dev/null +++ b/tests/functional/endpoint-rules/bedrock-agent/endpoint-tests-1.json @@ -0,0 +1,314 @@ +{ + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/tests/functional/endpoint-rules/qbusiness/endpoint-tests-1.json b/tests/functional/endpoint-rules/qbusiness/endpoint-tests-1.json new file mode 100644 index 0000000000..9e9effe71f --- /dev/null +++ b/tests/functional/endpoint-rules/qbusiness/endpoint-tests-1.json @@ -0,0 +1,119 @@ +{ + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/tests/functional/endpoint-rules/qconnect/endpoint-tests-1.json b/tests/functional/endpoint-rules/qconnect/endpoint-tests-1.json new file mode 100644 index 0000000000..6357b35cff --- /dev/null +++ b/tests/functional/endpoint-rules/qconnect/endpoint-tests-1.json @@ -0,0 +1,314 @@ +{ + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wisdom.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/tests/functional/endpoint-rules/s3/endpoint-tests-1.json b/tests/functional/endpoint-rules/s3/endpoint-tests-1.json index daa904ca39..ab313b9d9c 100644 --- a/tests/functional/endpoint-rules/s3/endpoint-tests-1.json +++ b/tests/functional/endpoint-rules/s3/endpoint-tests-1.json @@ -7719,6 +7719,765 @@ "UseDualStack": false, "Accelerate": false } + }, + { + "documentation": "Data Plane with short AZ", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--use1-az1--x-s3.s3express-use1-az1.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--use1-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--use1-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with short AZ fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--use1-az1--x-s3.s3express-fips-use1-az1.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--use1-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--use1-az1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with long AZ", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "ap-northeast-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--apne1-az1--x-s3.s3express-apne1-az1.ap-northeast-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "ap-northeast-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--apne1-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "ap-northeast-1", + "Bucket": "mybucket--apne1-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data Plane with long AZ fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "ap-northeast-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--apne1-az1--x-s3.s3express-fips-apne1-az1.ap-northeast-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "ap-northeast-1", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--apne1-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "ap-northeast-1", + "Bucket": "mybucket--apne1-az1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Control plane with short AZ bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://s3express-control.us-east-1.amazonaws.com/mybucket--use1-az1--x-s3" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "CreateBucket", + "operationParams": { + "Bucket": "mybucket--use1-az1--x-s3" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--use1-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false + } + }, + { + "documentation": "Control plane with short AZ bucket and fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://s3express-control-fips.us-east-1.amazonaws.com/mybucket--use1-az1--x-s3" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "CreateBucket", + "operationParams": { + "Bucket": "mybucket--use1-az1--x-s3" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--use1-az1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false + } + }, + { + "documentation": "Control plane without bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://s3express-control.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "ListDirectoryBuckets" + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false + } + }, + { + "documentation": "Control plane without bucket and fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://s3express-control-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "ListDirectoryBuckets" + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false + } + }, + { + "documentation": "Data Plane sigv4 auth with short AZ", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--usw2-az1--x-s3.s3express-usw2-az1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with short AZ fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--usw2-az1--x-s3.s3express-fips-usw2-az1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with long AZ", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "ap-northeast-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--apne1-az1--x-s3.s3express-apne1-az1.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "Bucket": "mybucket--apne1-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with long AZ fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "ap-northeast-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--apne1-az1--x-s3.s3express-fips-apne1-az1.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "Bucket": "mybucket--apne1-az1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Control Plane host override", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--usw2-az1--x-s3.custom.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": true, + "Endpoint": "https://custom.com" + } + }, + { + "documentation": "Control Plane host override no bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://custom.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": true, + "Endpoint": "https://custom.com" + } + }, + { + "documentation": "Data plane host override non virtual session auth", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://10.0.0.1/mybucket--usw2-az1--x-s3" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://10.0.0.1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--usw2-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://10.0.0.1" + } + }, + { + "documentation": "Control Plane host override ip", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://10.0.0.1/mybucket--usw2-az1--x-s3" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": true, + "Endpoint": "https://10.0.0.1" + } + }, + { + "documentation": "Data plane host override", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--usw2-az1--x-s3.custom.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://custom.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--usw2-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://custom.com" + } + }, + { + "documentation": "bad format error", + "expect": { + "error": "Unrecognized S3Express bucket name format." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--usaz1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--usaz1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "bad format error no session auth", + "expect": { + "error": "Unrecognized S3Express bucket name format." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--usaz1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--usaz1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "dual-stack error", + "expect": { + "error": "S3Express does not support Dual-stack." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--use1-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--use1-az1--x-s3", + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "accelerate error", + "expect": { + "error": "S3Express does not support S3 Accelerate." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--use1-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "mybucket--use1-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": true, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "Data plane bucket format error", + "expect": { + "error": "S3Express bucket name is not a valid virtual hostable name." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "my.bucket--use1-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "my.bucket--use1-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, + { + "documentation": "host override data plane bucket error session auth", + "expect": { + "error": "S3Express bucket name is not a valid virtual hostable name." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://custom.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "my.bucket--usw2-az1--x-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "my.bucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://custom.com" + } + }, + { + "documentation": "host override data plane bucket error", + "expect": { + "error": "S3Express bucket name is not a valid virtual hostable name." + }, + "params": { + "Region": "us-west-2", + "Bucket": "my.bucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://custom.com", + "DisableS3ExpressSessionAuth": true + } } ], "version": "1.0" From 40ef94ae9fd3f1b3fd36a3b24863d0083acee41f Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Tue, 28 Nov 2023 18:59:49 +0000 Subject: [PATCH 4/5] Update to latest partitions and endpoints --- botocore/data/endpoints.json | 179 +++++++++++++++++++++++++++++++++++ 1 file changed, 179 insertions(+) diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 7cf232810c..5607d66013 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -12988,6 +12988,102 @@ "us-west-2" : { } } }, + "qbusiness" : { + "defaults" : { + "dnsSuffix" : "api.aws", + "variants" : [ { + "dnsSuffix" : "api.aws", + "hostname" : "{service}-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, + "endpoints" : { + "af-south-1" : { + "hostname" : "qbusiness.af-south-1.api.aws" + }, + "ap-east-1" : { + "hostname" : "qbusiness.ap-east-1.api.aws" + }, + "ap-northeast-1" : { + "hostname" : "qbusiness.ap-northeast-1.api.aws" + }, + "ap-northeast-2" : { + "hostname" : "qbusiness.ap-northeast-2.api.aws" + }, + "ap-northeast-3" : { + "hostname" : "qbusiness.ap-northeast-3.api.aws" + }, + "ap-south-1" : { + "hostname" : "qbusiness.ap-south-1.api.aws" + }, + "ap-south-2" : { + "hostname" : "qbusiness.ap-south-2.api.aws" + }, + "ap-southeast-1" : { + "hostname" : "qbusiness.ap-southeast-1.api.aws" + }, + "ap-southeast-2" : { + "hostname" : "qbusiness.ap-southeast-2.api.aws" + }, + "ap-southeast-3" : { + "hostname" : "qbusiness.ap-southeast-3.api.aws" + }, + "ap-southeast-4" : { + "hostname" : "qbusiness.ap-southeast-4.api.aws" + }, + "ca-central-1" : { + "hostname" : "qbusiness.ca-central-1.api.aws" + }, + "eu-central-1" : { + "hostname" : "qbusiness.eu-central-1.api.aws" + }, + "eu-central-2" : { + "hostname" : "qbusiness.eu-central-2.api.aws" + }, + "eu-north-1" : { + "hostname" : "qbusiness.eu-north-1.api.aws" + }, + "eu-south-1" : { + "hostname" : "qbusiness.eu-south-1.api.aws" + }, + "eu-south-2" : { + "hostname" : "qbusiness.eu-south-2.api.aws" + }, + "eu-west-1" : { + "hostname" : "qbusiness.eu-west-1.api.aws" + }, + "eu-west-2" : { + "hostname" : "qbusiness.eu-west-2.api.aws" + }, + "eu-west-3" : { + "hostname" : "qbusiness.eu-west-3.api.aws" + }, + "il-central-1" : { + "hostname" : "qbusiness.il-central-1.api.aws" + }, + "me-central-1" : { + "hostname" : "qbusiness.me-central-1.api.aws" + }, + "me-south-1" : { + "hostname" : "qbusiness.me-south-1.api.aws" + }, + "sa-east-1" : { + "hostname" : "qbusiness.sa-east-1.api.aws" + }, + "us-east-1" : { + "hostname" : "qbusiness.us-east-1.api.aws" + }, + "us-east-2" : { + "hostname" : "qbusiness.us-east-2.api.aws" + }, + "us-west-1" : { + "hostname" : "qbusiness.us-west-1.api.aws" + }, + "us-west-2" : { + "hostname" : "qbusiness.us-west-2.api.aws" + } + } + }, "qldb" : { "endpoints" : { "ap-northeast-1" : { }, @@ -19881,6 +19977,24 @@ } } }, + "qbusiness" : { + "defaults" : { + "dnsSuffix" : "api.amazonwebservices.com.cn", + "variants" : [ { + "dnsSuffix" : "api.amazonwebservices.com.cn", + "hostname" : "{service}-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, + "endpoints" : { + "cn-north-1" : { + "hostname" : "qbusiness.cn-north-1.api.amazonwebservices.com.cn" + }, + "cn-northwest-1" : { + "hostname" : "qbusiness.cn-northwest-1.api.amazonwebservices.com.cn" + } + } + }, "ram" : { "endpoints" : { "cn-north-1" : { }, @@ -21696,6 +21810,36 @@ } } }, + "drs" : { + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "drs-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "drs-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "drs-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "drs-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "ds" : { "endpoints" : { "fips-us-gov-east-1" : { @@ -23518,6 +23662,24 @@ } } }, + "qbusiness" : { + "defaults" : { + "dnsSuffix" : "api.aws", + "variants" : [ { + "dnsSuffix" : "api.aws", + "hostname" : "{service}-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, + "endpoints" : { + "us-gov-east-1" : { + "hostname" : "qbusiness.us-gov-east-1.api.aws" + }, + "us-gov-west-1" : { + "hostname" : "qbusiness.us-gov-west-1.api.aws" + } + } + }, "quicksight" : { "endpoints" : { "api" : { }, @@ -25116,6 +25278,23 @@ "us-iso-east-1" : { } } }, + "datasync" : { + "endpoints" : { + "fips-us-iso-west-1" : { + "credentialScope" : { + "region" : "us-iso-west-1" + }, + "deprecated" : true, + "hostname" : "datasync-fips.us-iso-west-1.c2s.ic.gov" + }, + "us-iso-west-1" : { + "variants" : [ { + "hostname" : "datasync-fips.us-iso-west-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + } + } + }, "directconnect" : { "endpoints" : { "us-iso-east-1" : { }, From e8a9f3823e21001d78709a59dd79ee066fbdc243 Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Tue, 28 Nov 2023 18:59:51 +0000 Subject: [PATCH 5/5] Bumping version to 1.33.2 --- .changes/1.33.2.json | 62 +++++++++++++++++++ .../api-change-accessanalyzer-49701.json | 5 -- .../api-change-bedrock-34731.json | 5 -- .../api-change-bedrockagent-69815.json | 5 -- .../api-change-bedrockagentruntime-92513.json | 5 -- .../api-change-bedrockruntime-29758.json | 5 -- .../api-change-connect-51996.json | 5 -- .../api-change-customerprofiles-94400.json | 5 -- .../api-change-endpointrules-96440.json | 5 -- .../api-change-qbusiness-11571.json | 5 -- .../api-change-qconnect-80765.json | 5 -- .../next-release/api-change-s3-30237.json | 5 -- .../api-change-s3control-97162.json | 5 -- CHANGELOG.rst | 17 +++++ botocore/__init__.py | 2 +- docs/source/conf.py | 2 +- 16 files changed, 81 insertions(+), 62 deletions(-) create mode 100644 .changes/1.33.2.json delete mode 100644 .changes/next-release/api-change-accessanalyzer-49701.json delete mode 100644 .changes/next-release/api-change-bedrock-34731.json delete mode 100644 .changes/next-release/api-change-bedrockagent-69815.json delete mode 100644 .changes/next-release/api-change-bedrockagentruntime-92513.json delete mode 100644 .changes/next-release/api-change-bedrockruntime-29758.json delete mode 100644 .changes/next-release/api-change-connect-51996.json delete mode 100644 .changes/next-release/api-change-customerprofiles-94400.json delete mode 100644 .changes/next-release/api-change-endpointrules-96440.json delete mode 100644 .changes/next-release/api-change-qbusiness-11571.json delete mode 100644 .changes/next-release/api-change-qconnect-80765.json delete mode 100644 .changes/next-release/api-change-s3-30237.json delete mode 100644 .changes/next-release/api-change-s3control-97162.json diff --git a/.changes/1.33.2.json b/.changes/1.33.2.json new file mode 100644 index 0000000000..c0c496eff2 --- /dev/null +++ b/.changes/1.33.2.json @@ -0,0 +1,62 @@ +[ + { + "category": "``accessanalyzer``", + "description": "This release adds support for external access findings for S3 directory buckets to help you easily identify cross-account access. Updated service API, documentation, and paginators.", + "type": "api-change" + }, + { + "category": "``bedrock``", + "description": "This release adds support for customization types, model life cycle status and minor versions/aliases for model identifiers.", + "type": "api-change" + }, + { + "category": "``bedrock-agent``", + "description": "This release introduces Agents for Amazon Bedrock", + "type": "api-change" + }, + { + "category": "``bedrock-agent-runtime``", + "description": "This release introduces Agents for Amazon Bedrock Runtime", + "type": "api-change" + }, + { + "category": "``bedrock-runtime``", + "description": "This release adds support for minor versions/aliases for invoke model identifier.", + "type": "api-change" + }, + { + "category": "``connect``", + "description": "Added support for following capabilities: Amazon Connect's in-app, web, and video calling. Two-way SMS integrations. Contact Lens real-time chat analytics feature. Amazon Connect Analytics Datalake capability. Capability to configure real time chat rules.", + "type": "api-change" + }, + { + "category": "``customer-profiles``", + "description": "This release introduces DetectProfileObjectType API to auto generate object type mapping.", + "type": "api-change" + }, + { + "category": "``endpoint-rules``", + "description": "Update endpoint-rules client to latest version", + "type": "api-change" + }, + { + "category": "``qbusiness``", + "description": "Amazon Q - a generative AI powered application that your employees can use to ask questions and get answers from knowledge spread across disparate content repositories, summarize reports, write articles, take actions, and much more - all within their company's connected content repositories.", + "type": "api-change" + }, + { + "category": "``qconnect``", + "description": "Amazon Q in Connect, an LLM-enhanced evolution of Amazon Connect Wisdom. This release adds generative AI support to Amazon Q Connect QueryAssistant and GetRecommendations APIs.", + "type": "api-change" + }, + { + "category": "``s3``", + "description": "Adds support for S3 Express One Zone.", + "type": "api-change" + }, + { + "category": "``s3control``", + "description": "Adds support for S3 Express One Zone, and InvocationSchemaVersion 2.0 for S3 Batch Operations.", + "type": "api-change" + } +] \ No newline at end of file diff --git a/.changes/next-release/api-change-accessanalyzer-49701.json b/.changes/next-release/api-change-accessanalyzer-49701.json deleted file mode 100644 index d5b3b95a4e..0000000000 --- a/.changes/next-release/api-change-accessanalyzer-49701.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``accessanalyzer``", - "description": "This release adds support for external access findings for S3 directory buckets to help you easily identify cross-account access. Updated service API, documentation, and paginators." -} diff --git a/.changes/next-release/api-change-bedrock-34731.json b/.changes/next-release/api-change-bedrock-34731.json deleted file mode 100644 index f5ecb3fd31..0000000000 --- a/.changes/next-release/api-change-bedrock-34731.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``bedrock``", - "description": "This release adds support for customization types, model life cycle status and minor versions/aliases for model identifiers." -} diff --git a/.changes/next-release/api-change-bedrockagent-69815.json b/.changes/next-release/api-change-bedrockagent-69815.json deleted file mode 100644 index a4e5131f3d..0000000000 --- a/.changes/next-release/api-change-bedrockagent-69815.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``bedrock-agent``", - "description": "This release introduces Agents for Amazon Bedrock" -} diff --git a/.changes/next-release/api-change-bedrockagentruntime-92513.json b/.changes/next-release/api-change-bedrockagentruntime-92513.json deleted file mode 100644 index a28079c619..0000000000 --- a/.changes/next-release/api-change-bedrockagentruntime-92513.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``bedrock-agent-runtime``", - "description": "This release introduces Agents for Amazon Bedrock Runtime" -} diff --git a/.changes/next-release/api-change-bedrockruntime-29758.json b/.changes/next-release/api-change-bedrockruntime-29758.json deleted file mode 100644 index 6f4470b702..0000000000 --- a/.changes/next-release/api-change-bedrockruntime-29758.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``bedrock-runtime``", - "description": "This release adds support for minor versions/aliases for invoke model identifier." -} diff --git a/.changes/next-release/api-change-connect-51996.json b/.changes/next-release/api-change-connect-51996.json deleted file mode 100644 index b7007b75e8..0000000000 --- a/.changes/next-release/api-change-connect-51996.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``connect``", - "description": "Added support for following capabilities: Amazon Connect's in-app, web, and video calling. Two-way SMS integrations. Contact Lens real-time chat analytics feature. Amazon Connect Analytics Datalake capability. Capability to configure real time chat rules." -} diff --git a/.changes/next-release/api-change-customerprofiles-94400.json b/.changes/next-release/api-change-customerprofiles-94400.json deleted file mode 100644 index fb8874fa9b..0000000000 --- a/.changes/next-release/api-change-customerprofiles-94400.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``customer-profiles``", - "description": "This release introduces DetectProfileObjectType API to auto generate object type mapping." -} diff --git a/.changes/next-release/api-change-endpointrules-96440.json b/.changes/next-release/api-change-endpointrules-96440.json deleted file mode 100644 index 00deedc0ca..0000000000 --- a/.changes/next-release/api-change-endpointrules-96440.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``endpoint-rules``", - "description": "Update endpoint-rules client to latest version" -} diff --git a/.changes/next-release/api-change-qbusiness-11571.json b/.changes/next-release/api-change-qbusiness-11571.json deleted file mode 100644 index c4f78c862a..0000000000 --- a/.changes/next-release/api-change-qbusiness-11571.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``qbusiness``", - "description": "Amazon Q - a generative AI powered application that your employees can use to ask questions and get answers from knowledge spread across disparate content repositories, summarize reports, write articles, take actions, and much more - all within their company's connected content repositories." -} diff --git a/.changes/next-release/api-change-qconnect-80765.json b/.changes/next-release/api-change-qconnect-80765.json deleted file mode 100644 index d5c1c6d0ec..0000000000 --- a/.changes/next-release/api-change-qconnect-80765.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``qconnect``", - "description": "Amazon Q in Connect, an LLM-enhanced evolution of Amazon Connect Wisdom. This release adds generative AI support to Amazon Q Connect QueryAssistant and GetRecommendations APIs." -} diff --git a/.changes/next-release/api-change-s3-30237.json b/.changes/next-release/api-change-s3-30237.json deleted file mode 100644 index 8d5fb40230..0000000000 --- a/.changes/next-release/api-change-s3-30237.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``s3``", - "description": "Adds support for S3 Express One Zone." -} diff --git a/.changes/next-release/api-change-s3control-97162.json b/.changes/next-release/api-change-s3control-97162.json deleted file mode 100644 index 2bf026ee14..0000000000 --- a/.changes/next-release/api-change-s3control-97162.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``s3control``", - "description": "Adds support for S3 Express One Zone, and InvocationSchemaVersion 2.0 for S3 Batch Operations." -} diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 03bb4a89cc..a22d9ec407 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,23 @@ CHANGELOG ========= +1.33.2 +====== + +* api-change:``accessanalyzer``: This release adds support for external access findings for S3 directory buckets to help you easily identify cross-account access. Updated service API, documentation, and paginators. +* api-change:``bedrock``: This release adds support for customization types, model life cycle status and minor versions/aliases for model identifiers. +* api-change:``bedrock-agent``: This release introduces Agents for Amazon Bedrock +* api-change:``bedrock-agent-runtime``: This release introduces Agents for Amazon Bedrock Runtime +* api-change:``bedrock-runtime``: This release adds support for minor versions/aliases for invoke model identifier. +* api-change:``connect``: Added support for following capabilities: Amazon Connect's in-app, web, and video calling. Two-way SMS integrations. Contact Lens real-time chat analytics feature. Amazon Connect Analytics Datalake capability. Capability to configure real time chat rules. +* api-change:``customer-profiles``: This release introduces DetectProfileObjectType API to auto generate object type mapping. +* api-change:``endpoint-rules``: Update endpoint-rules client to latest version +* api-change:``qbusiness``: Amazon Q - a generative AI powered application that your employees can use to ask questions and get answers from knowledge spread across disparate content repositories, summarize reports, write articles, take actions, and much more - all within their company's connected content repositories. +* api-change:``qconnect``: Amazon Q in Connect, an LLM-enhanced evolution of Amazon Connect Wisdom. This release adds generative AI support to Amazon Q Connect QueryAssistant and GetRecommendations APIs. +* api-change:``s3``: Adds support for S3 Express One Zone. +* api-change:``s3control``: Adds support for S3 Express One Zone, and InvocationSchemaVersion 2.0 for S3 Batch Operations. + + 1.33.1 ====== diff --git a/botocore/__init__.py b/botocore/__init__.py index 5b4f902433..f7b1c60b9b 100644 --- a/botocore/__init__.py +++ b/botocore/__init__.py @@ -16,7 +16,7 @@ import os import re -__version__ = '1.33.1' +__version__ = '1.33.2' class NullHandler(logging.Handler): diff --git a/docs/source/conf.py b/docs/source/conf.py index 684f09ea0b..45d5a39f85 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.33' # The full version, including alpha/beta/rc tags. -release = '1.33.1' +release = '1.33.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.